Struct fidl_fuchsia_component_decl::UseProtocol

pub struct UseProtocol {
    pub source: Option<Ref>,
    pub source_name: Option<String>,
    pub target_path: Option<String>,
    pub dependency_type: Option<DependencyType>,
    pub availability: Option<Availability>,
    pub source_dictionary: Option<String>,
    /* private fields */
}

Declares a protocol used by a component, which was offered to it.

A protocol is a service with a single instance, provided by a single FIDL protocol.

Fields

source: Option<Ref>

(Required) The provider of the protocol relative to the component itself. Must be parent, framework, debug, capability or child.

source_name: Option<String>

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

target_path: Option<String>

(Required) The path where the capability should be installed in the component’s namespace.

Must be an absolute path starting with /.

dependency_type: Option<DependencyType>

(Required) The dependency type this use represents.

A component which offers a capability to a child from itself and uses a capability from the same child, must mark the dependency as weak. A weak dependency implies that the capability may become unavailable at any point. Taking a strong dependency on a child’s capability will cause this the child to shut down before its parent. When using a weak dependency, the parent shuts down before the child.

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.

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 UseProtocol

fn clone(&self) -> UseProtocol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UseProtocol

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

Formats the value using the given formatter.

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

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 UseProtocol

fn default() -> UseProtocol

Returns the “default value” for a type.

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

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 UseProtocol

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

type Owned = UseProtocol

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 UseProtocol

type Borrowed<'a> = &'a UseProtocol

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 UseProtocol

impl StructuralPartialEq for UseProtocol