Struct UseConfiguration

pub struct UseConfiguration {
    pub source: Option<Ref>,
    pub source_name: Option<String>,
    pub target_name: Option<String>,
    pub availability: Option<Availability>,
    pub type_: Option<ConfigType>,
    pub default: Option<ConfigValue>,
    pub source_dictionary: Option<String>,
    /* private fields */
}

Fields

source: Option<Ref>

(Required) The provider of the configuration relative to the component itself. Must be parent, self, child.

source_name: Option<String>

(Required) Name identifying the configuration, by which it was presented to this component.

target_name: Option<String>

(Required) The name that the component sees for this configuration. This must match a key in the ‘config’ schema for this component. The matching config field’s type must match this configuration type.

availability: Option<Availability>

(Optional, defaults to REQUIRED) The availability of this capability. If set to required, the component is likely to malfunction if this capability is not provided. If set to optional, the component can handle the capability’s absence.

type_: Option<ConfigType>

(Required) The type of this config value. If target_name matches a key in the config schema, then this type must match that type.

default: Option<ConfigValue>

(Optional): If this is set, this is the value that will be provided via routing if the capability is successfully routed from void.

source_dictionary: Option<String>

(Optional) Path in a dictionary provided by source which contains source_name. If this field is absent, source_name identifies a capability directly routed by source. If set, source_name identifies a capability nested inside this dictionary.

Trait Implementations

impl Clone for UseConfiguration

fn clone(&self) -> UseConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UseConfiguration

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

Formats the value using the given formatter.

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

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 UseConfiguration

fn default() -> UseConfiguration

Returns the “default value” for a type.

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

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 UseConfiguration

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

type Owned = UseConfiguration

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 UseConfiguration

type Borrowed<'a> = &'a UseConfiguration

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 UseConfiguration

impl StructuralPartialEq for UseConfiguration