Struct cml::Capability

source ·
pub struct Capability {
Show 21 fields pub service: Option<OneOrMany<Name>>, pub protocol: Option<OneOrMany<Name>>, pub directory: Option<Name>, pub storage: Option<Name>, pub runner: Option<Name>, pub resolver: Option<Name>, pub event_stream: Option<OneOrMany<Name>>, pub dictionary: Option<Name>, pub config: Option<Name>, pub path: Option<Path>, pub rights: Option<Rights>, pub from: Option<CapabilityFromRef>, pub extends: Option<DictionaryRef>, pub backing_dir: Option<Name>, pub subdir: Option<RelativePath>, pub storage_id: Option<StorageId>, pub config_type: Option<ConfigType>, pub config_max_size: Option<NonZeroU32>, pub config_max_count: Option<NonZeroU32>, pub config_element_type: Option<ConfigNestedValueType>, pub value: Option<Value>,
}

Fields§

§service: Option<OneOrMany<Name>>

The name for this service capability. Specifying path is valid only when this value is a string.

§protocol: Option<OneOrMany<Name>>

The name for this protocol capability. Specifying path is valid only when this value is a string.

§directory: Option<Name>

The name for this directory capability.

§storage: Option<Name>

The name for this storage capability.

§runner: Option<Name>

The name for this runner capability.

§resolver: Option<Name>

The name for this resolver capability.

§event_stream: Option<OneOrMany<Name>>

The name for this event_stream capability.

§dictionary: Option<Name>

The name for this dictionary capability.

§config: Option<Name>

The name for this configuration capability.

§path: Option<Path>

The path within the [outgoing directory][glossary.outgoing directory] of the component’s program to source the capability.

For protocol and service, defaults to /svc/${protocol}, otherwise required.

For protocol, the target of the path MUST be a channel, which tends to speak the protocol matching the name of this capability.

For service, directory, the target of the path MUST be a directory.

For runner, the target of the path MUST be a channel and MUST speak the protocol fuchsia.component.runner.ComponentRunner.

For resolver, the target of the path MUST be a channel and MUST speak the protocol fuchsia.component.resolution.Resolver.

§rights: Option<Rights>

(directory only) The maximum [directory rights][doc-directory-rights] that may be set when using this directory.

§from: Option<CapabilityFromRef>

(storage only) The source component of an existing directory capability backing this storage capability, one of:

  • parent: The component’s parent.
  • self: This component.
  • #<child-name>: A reference to a child component instance.
§extends: Option<DictionaryRef>

(dictionary only, optional) The contents to initialize a dictionary with. One of:

  • parent/<relative_path>: A path to a dictionary offered by parent.
  • #<child-name>/<relative_path>: A path to a dictionary exposed by #<child-name>.
  • self/<relative_path>: A path to a dictionary defined by this component. <relative_path> may be either a name, identifying a dictionary capability), or a path with multiple parts, identifying a nested dictionary.
§backing_dir: Option<Name>

(storage only) The name of the directory capability backing the storage. The capability must be available from the component referenced in from.

§subdir: Option<RelativePath>

(storage only) A subdirectory within backing_dir where per-component isolated storage directories are created

§storage_id: Option<StorageId>

(storage only) The identifier used to isolated storage for a component, one of:

  • static_instance_id: The instance ID in the component ID index is used as the key for a component’s storage. Components which are not listed in the component ID index will not be able to use this storage capability.
  • static_instance_id_or_moniker: If the component is listed in the component ID index, the instance ID is used as the key for a component’s storage. Otherwise, the component’s moniker from the storage capability is used.
§config_type: Option<ConfigType>

(configuration only) The type of configuration, one of:

  • bool: Boolean type.
  • uint8: Unsigned 8 bit type.
  • uint16: Unsigned 16 bit type.
  • uint32: Unsigned 32 bit type.
  • uint64: Unsigned 64 bit type.
  • int8: Signed 8 bit type.
  • int16: Signed 16 bit type.
  • int32: Signed 32 bit type.
  • int64: Signed 64 bit type.
  • string: ASCII string type.
  • vector: Vector type. See element for the type of the element within the vector.
§config_max_size: Option<NonZeroU32>

(configuration only) Only supported if this configuration type is ‘string’. This is the max size of the string.

§config_max_count: Option<NonZeroU32>

(configuration only) Only supported if this configuration type is ‘vector’. This is the max number of elements in the vector.

§config_element_type: Option<ConfigNestedValueType>

(configuration only) Only supported if this configuration type is ‘vector’. This is the type of the elements in the configuration vector.

Example (simple type):

{ type: "uint8" }

Example (string type):

{
  type: "string",
  max_size: 100,
}
§value: Option<Value>

(configuration only) The value of the configuration.

Trait Implementations§

source§

impl AsClause for Capability

source§

fn as(&self) -> Option<&Name>

source§

impl CapabilityClause for Capability

source§

fn service(&self) -> Option<OneOrMany<&Name>>

source§

fn protocol(&self) -> Option<OneOrMany<&Name>>

source§

fn directory(&self) -> Option<OneOrMany<&Name>>

source§

fn storage(&self) -> Option<OneOrMany<&Name>>

source§

fn runner(&self) -> Option<OneOrMany<&Name>>

source§

fn resolver(&self) -> Option<OneOrMany<&Name>>

source§

fn event_stream(&self) -> Option<OneOrMany<&Name>>

source§

fn dictionary(&self) -> Option<OneOrMany<&Name>>

source§

fn config(&self) -> Option<OneOrMany<&Name>>

source§

fn set_service(&mut self, o: Option<OneOrMany<Name>>)

source§

fn set_protocol(&mut self, o: Option<OneOrMany<Name>>)

source§

fn set_directory(&mut self, o: Option<OneOrMany<Name>>)

source§

fn set_storage(&mut self, o: Option<OneOrMany<Name>>)

source§

fn set_runner(&mut self, o: Option<OneOrMany<Name>>)

source§

fn set_resolver(&mut self, o: Option<OneOrMany<Name>>)

source§

fn set_event_stream(&mut self, o: Option<OneOrMany<Name>>)

source§

fn set_dictionary(&mut self, o: Option<OneOrMany<Name>>)

source§

fn set_config(&mut self, o: Option<OneOrMany<Name>>)

source§

fn availability(&self) -> Option<Availability>

source§

fn set_availability(&mut self, _a: Option<Availability>)

source§

fn capability_type(&self) -> &'static str

Returns the name of the capability for display purposes. If service() returns Some, the capability name must be “service”, etc. Read more
source§

fn decl_type(&self) -> &'static str

source§

fn supported(&self) -> &[&'static str]

source§

fn are_many_names_allowed(&self) -> bool

Returns true if this capability type allows the ::Many variant of OneOrMany.
source§

fn names(&self) -> Vec<&Name>

Returns the names of the capabilities in this clause. If protocol() returns Some(OneOrMany::Many(vec!["a", "b"])), this returns![“a”, “b”].
source§

fn set_names(&mut self, names: Vec<Name>)

source§

impl Clone for Capability

source§

fn clone(&self) -> Capability

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Capability

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Capability

source§

fn default() -> Capability

Returns the “default value” for a type. Read more
source§

impl<'de> Deserialize<'de> for Capability

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl FilterClause for Capability

source§

impl MarkdownReferenceDocGenerator for Capability

source§

fn get_reference_doc_markdown() -> String

Returns a Markdown representation of the reference docs for the struct that is derived from ReferenceDoc. The returned Markdown indents any # Markdown headers in individual field doc comments to ensure a well structured final Markdown document.
§

fn get_reference_doc_markdown_with_options( indent_headers_by: usize, indent_with_spaces: usize ) -> String

This method is called internally by the reference doc generator when recursing to generate documentation for field types.
source§

impl PartialEq for Capability

source§

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

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

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.
source§

impl PathClause for Capability

source§

fn path(&self) -> Option<&Path>

source§

impl RightsClause for Capability

source§

impl Serialize for Capability

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl StructuralPartialEq for Capability

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Encode<Ambiguous1> for T

source§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> Encode<Ambiguous2> for T

source§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoAny for T
where T: 'static + Send + Sync,

source§

fn into_any(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Cast the given object into a dyn std::any::Any.
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,