Struct fidl_fuchsia_component_decl::OfferProtocol

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

Declares a protocol offered by a component to one of its children, which may have been offered by the component’s containing realm, the component itself, or one of its other children.

To learn more about protocols, see: https://fuchsia.dev/fuchsia-src/glossary#protocol

Fields

source: Option<Ref>

(Required) The provider of the capability relative to the component itself. Must be parent, self, child, or void. If set to void, then the target must offer or use the capability with OPTIONAL or TRANSITIONAL availability.

source_name: Option<String>

(Required) Name identifying the protocol being offered.

target: Option<Ref>

(Required) Reference to the target. Must be child, collection, or a dictionary capability.

target_name: Option<String>

(Required) The name by which the capability is being offered.

dependency_type: Option<DependencyType>

(Required) The dependency type this offer represents. A component which receives a weak offer must support the offered capability being unavailable at any point.

availability: Option<Availability>

(Optional, defaults to REQUIRED) The availability of this capability. If set to required, the target may use or offer the capability with either required or optional availability. If set to optional, the target must use or offer the capability with optional availability. The same_as_target value causes this offer’s availability to match the availability set in the target.

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 OfferProtocol

fn clone(&self) -> OfferProtocol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OfferProtocol

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

Formats the value using the given formatter.

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

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 OfferProtocol

fn default() -> OfferProtocol

Returns the “default value” for a type.

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

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 OfferProtocol

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

type Owned = OfferProtocol

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 OfferProtocol

type Borrowed<'a> = &'a OfferProtocol

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 OfferProtocol

impl StructuralPartialEq for OfferProtocol