Struct ItemName

Source

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

Expand description

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§

Source §

impl ItemName

Source

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())
);