Struct Component

pub struct Component {
    pub program: Option<Program>,
    pub uses: Option<Vec<Use>>,
    pub exposes: Option<Vec<Expose>>,
    pub offers: Option<Vec<Offer>>,
    pub capabilities: Option<Vec<Capability>>,
    pub children: Option<Vec<Child>>,
    pub collections: Option<Vec<Collection>>,
    pub environments: Option<Vec<Environment>>,
    pub facets: Option<Dictionary>,
    pub config: Option<ConfigSchema>,
    /* private fields */
}

A component declaration.

This information is typically encoded in the component manifest (.cm file) if it has one or may be generated at runtime by a component resolver for those that don’t.

Fields

program: Option<Program>

(Optional) Information about the program to run when the component is executed. Omitted for non-executable components.

uses: Option<Vec<Use>>

(Optional) List of capabilities used by the component. These consist of capabilities offered to the component that are installed in its incoming namespace.

The used capabilities must be unique and non-overlapping.

exposes: Option<Vec<Expose>>

(Optional) List of capabilities exposed by the component. These consist of capabilities that are made visible to the parent. The parent may offer these capabilities to its children, but not use them.

The exposed capabilities must be unique and non-overlapping.

offers: Option<Vec<Offer>>

(Optional) List of capabilities offered to the component’s children. These consist of capabilities that the given children may use, which may come from a child, the parent, or the component’s own outgoing namespace.

The offered capabilities must be unique and non-overlapping.

capabilities: Option<Vec<Capability>>

(Optional) List of capabilities defined by the component.

children: Option<Vec<Child>>

(Optional) The component’s statically instantiated children. The children must have unique names.

collections: Option<Vec<Collection>>

(Optional) The component’s collections. The collections must have unique names.

environments: Option<Vec<Environment>>

(Optional) List of environments created by this component. Environments are assigned to children and control aspects of a child component’s runtime.

facets: Option<Dictionary>

(Optional) Additional metadata about the component.

config: Option<ConfigSchema>

(Optional) The schema of the component’s configuration interface.

Trait Implementations

impl Clone for Component

fn clone(&self) -> Component

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Component

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

Formats the value using the given formatter.

impl<D: ResourceDialect> Decode<Component, D> for Component

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, depth: Depth, ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl Default for Component

fn default() -> Component

Returns the “default value” for a type.

impl<D: ResourceDialect> Encode<Component, D> for &Component

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, depth: Depth, ) -> Result<()>

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

impl PartialEq for Component

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

type Owned = Component

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for Component

type Borrowed<'a> = &'a Component

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow(value: &<Self as TypeMarker>::Owned) -> Self::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Persistable for Component

impl StructuralPartialEq for Component