Struct MetadataPath 

pub struct MetadataPath(/* private fields */);

Wrapper for a path to metadata.

Note: This should not contain the file extension. This is automatically added by the library depending on what type of data pouf format is being used.

use tuf::metadata::MetadataPath;

// right
let _ = MetadataPath::new("root");

// wrong
let _ = MetadataPath::new("root.json");

Implementations

impl MetadataPath

pub fn root() -> Self

Create a new MetadataPath for the Root role.

pub fn timestamp() -> Self

Create a new MetadataPath for the Timestamp role.

pub fn snapshot() -> Self

Create a new MetadataPath for the Snapshot role.

pub fn targets() -> Self

Create a new MetadataPath for the targets role.

pub fn new<P: Into<Cow<'static, str>>>(path: P) -> Result<Self>

Create a new MetadataPath from a String.

assert!(MetadataPath::new("foo").is_ok());
assert!(MetadataPath::new("/foo").is_err());
assert!(MetadataPath::new("../foo").is_err());
assert!(MetadataPath::new("foo/..").is_err());
assert!(MetadataPath::new("foo/../bar").is_err());
assert!(MetadataPath::new("..foo").is_ok());
assert!(MetadataPath::new("foo/..bar").is_ok());
assert!(MetadataPath::new("foo/bar..").is_ok());

pub fn components<D>(&self, version: MetadataVersion) -> Vec<String>

where D: Pouf,

Split MetadataPath into components that can be joined to create URL paths, Unix paths, or Windows paths.

let path = MetadataPath::new("foo/bar").unwrap();
assert_eq!(path.components::<Pouf1>(MetadataVersion::None),
           ["foo".to_string(), "bar.json".to_string()]);
assert_eq!(path.components::<Pouf1>(MetadataVersion::Number(1)),
           ["foo".to_string(), "1.bar.json".to_string()]);

Trait Implementations

impl Clone for MetadataPath

fn clone(&self) -> MetadataPath

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MetadataPath

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MetadataPath

fn deserialize<D: Deserializer<'de>>(de: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for MetadataPath

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Role> for MetadataPath

fn from(role: Role) -> MetadataPath

Converts to this type from the input type.

impl Hash for MetadataPath

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MetadataPath

fn cmp(&self, other: &MetadataPath) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MetadataPath

fn eq(&self, other: &MetadataPath) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for MetadataPath

fn partial_cmp(&self, other: &MetadataPath) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for MetadataPath

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for MetadataPath

impl StructuralPartialEq for MetadataPath