Struct ItemName 

pub struct ItemName {
    pub package: Option<PackageName>,
    pub interface: Option<String>,
    pub name: String,
}

The fully-qualified name of a Component Model item (function, type, or resource) as can be defined by wit. An item is optionally in a package, the package optionally has a version, and the item is optionally inside a namespace.

The syntax for an ItemName always uses the package version as a suffix, if it is given. The following tests show examples of the syntax for ItemName:

assert_eq!(
    "foo".parse::<ItemName>().unwrap(),
    ItemName {
        package: None,
        interface: None,
        name: "foo".to_owned()
    }
);
assert_eq!(
    "foo.bar".parse::<ItemName>().unwrap(),
    ItemName {
        package: None,
        interface: Some("foo".to_owned()),
        name: "bar".to_owned()
    }
);
assert_eq!(
    "foo:bar/baz".parse::<ItemName>().unwrap(),
    ItemName {
        package: Some(PackageName {
            namespace: "foo".to_owned(),
            name: "bar".to_owned(),
            version: None
        }),
        interface: None,
        name: "baz".to_owned()
    }
);
assert_eq!(
    "foo:bar/baz@0.1.0".parse::<ItemName>().unwrap(),
    ItemName {
        package: Some(PackageName {
            namespace: "foo".to_owned(),
            name: "bar".to_owned(),
            version: Some("0.1.0".parse().unwrap())
        }),
        interface: None,
        name: "baz".to_owned()
    }
);
assert_eq!(
    "foo:bar/baz.bat".parse::<ItemName>().unwrap(),
    ItemName {
        package: Some(PackageName {
            namespace: "foo".to_owned(),
            name: "bar".to_owned(),
            version: None
        }),
        interface: Some("baz".to_owned()),
        name: "bat".to_owned()
    }
);
assert_eq!(
    "foo:bar/baz.bat@0.1.0".parse::<ItemName>().unwrap(),
    ItemName {
        package: Some(PackageName {
            namespace: "foo".to_owned(),
            name: "bar".to_owned(),
            version: Some("0.1.0".parse().unwrap()),
        }),
        interface: Some("baz".to_owned()),
        name: "bat".to_owned()
    }
);
assert!("foo@0.1.0".parse::<ItemName>().is_err());
assert!("foo:bar@0.1.0".parse::<ItemName>().is_err());
assert!("foo:bar/baz@0.1.0.bat".parse::<ItemName>().is_err());
assert!("foo.bar@0.1.0".parse::<ItemName>().is_err());
assert!("foo@0.1.0.bar".parse::<ItemName>().is_err());

Parse this from a string using its FromStr or TryFrom<String> impls. Display to render to the same string syntax.

Fields

package: Option<PackageName>

interface: Option<String>

name: String

Implementations

impl ItemName

pub fn instance_name(&self) -> Option<String>

Get the name of the component instance containing this item, if any. The instance name will be formed like: “namespace.packagename/interfacename@0.1.0”

assert_eq!(
    "foo".parse::<ItemName>().unwrap().instance_name(),
    None,
);
assert_eq!(
    "foo.bar".parse::<ItemName>().unwrap().instance_name(),
    Some("foo".to_owned())
);
assert_eq!(
    "foo:bar/baz.bat@0.1.0".parse::<ItemName>().unwrap().instance_name(),
    Some("foo:bar/baz@0.1.0".to_owned())
);

Trait Implementations

impl Clone for ItemName

fn clone(&self) -> ItemName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ItemName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ItemName

fn deserialize<__D>( __deserializer: __D, ) -> Result<ItemName, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ItemName

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

Formats the value using the given formatter.

impl Eq for ItemName

impl ExportLookup for ItemName

Available on crate feature wit-parser only.

impl From<ItemName> for String

fn from(m: ItemName) -> String

Converts to this type from the input type.

impl FromStr for ItemName

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<ItemName, Error>

Parses a string s to return a value of this type.

impl Hash for ItemName

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

where __H: Hasher,

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 ItemName

fn cmp(&self, other: &ItemName) -> 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 ItemName

fn eq(&self, other: &ItemName) -> 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 ItemName

fn partial_cmp(&self, other: &ItemName) -> 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 ItemName

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ItemName

impl TryFrom<String> for ItemName

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<ItemName, Error>

Performs the conversion.