Enum cml::CapabilityId

pub enum CapabilityId<'a> {
    Service(&'a Name),
    Protocol(&'a Name),
    Directory(&'a Name),
    UsedService(Path),
    UsedProtocol(Path),
    UsedDirectory(Path),
    UsedStorage(Path),
    UsedEventStream(Path),
    UsedConfiguration(&'a Name),
    UsedRunner(&'a Name),
    Storage(&'a Name),
    Runner(&'a Name),
    Resolver(&'a Name),
    EventStream(&'a Name),
    Dictionary(&'a Name),
    Configuration(&'a Name),
}

A name/identity of a capability exposed/offered to another component.

Exposed or offered capabilities have an identifier whose format depends on the capability type. For directories and services this is a path, while for storage this is a storage name. Paths and storage names, however, are in different conceptual namespaces, and can’t collide with each other.

This enum allows such names to be specified disambiguating what namespace they are in.

Variants

Service(&'a Name)

Protocol(&'a Name)

Directory(&'a Name)

UsedService(Path)

UsedProtocol(Path)

UsedDirectory(Path)

UsedStorage(Path)

UsedEventStream(Path)

UsedConfiguration(&'a Name)

UsedRunner(&'a Name)

Storage(&'a Name)

Runner(&'a Name)

Resolver(&'a Name)

EventStream(&'a Name)

Dictionary(&'a Name)

Configuration(&'a Name)

Implementations

impl<'a> CapabilityId<'a>

pub fn type_str(&self) -> &'static str

Human readable description of this capability type.

pub fn get_dir_path(&self) -> Option<NamespacePath>

Return the directory containing the capability, if this capability takes a target path.

pub fn from_use(use_: &'a Use) -> Result<Vec<Self>, Error>

Given a Use clause, return the set of target identifiers.

When only one capability identifier is specified, the target identifier name is derived using the “path” clause. If a “path” clause is not specified, the target identifier is the same name as the source.

When multiple capability identifiers are specified, the target names are the same as the source names.

pub fn from_capability(capability: &'a Capability) -> Result<Vec<Self>, Error>

pub fn from_offer_expose<T>(clause: &'a T) -> Result<Vec<Self>, Error>

where T: CapabilityClause + AsClause + Debug,

Given an Offer or Expose clause, return the set of target identifiers.

When only one capability identifier is specified, the target identifier name is derived using the “as” clause. If an “as” clause is not specified, the target identifier is the same name as the source.

When multiple capability identifiers are specified, the target names are the same as the source names.

Trait Implementations

impl<'a> Clone for CapabilityId<'a>

fn clone(&self) -> CapabilityId<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CapabilityId<'a>

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

Formats the value using the given formatter.

impl Display for CapabilityId<'_>

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

Return the string ID of this clause.

impl<'a> Hash for CapabilityId<'a>

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<'a> PartialEq for CapabilityId<'a>

fn eq(&self, other: &CapabilityId<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> Eq for CapabilityId<'a>

impl<'a> StructuralPartialEq for CapabilityId<'a>