Struct OfferEventStream

pub struct OfferEventStream {
    pub source: Option<Ref>,
    pub source_name: Option<String>,
    pub scope: Option<Vec<Ref>>,
    pub target: Option<Ref>,
    pub target_name: Option<String>,
    pub availability: Option<Availability>,
    /* private fields */
}

Declares an event stream offered by a component.

Fields

source: Option<Ref>

(Required) The provider of the capability relative to the component itself. Must be parent, framework, 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 of the event being offered.

scope: Option<Vec<Ref>>

(Optional) When an event is offered from framework, the scope is required and allows one to define the child (or array of children) which the event is about. When the event is offered from parent, the scope can be used to downscope the event to a certain child scope, otherwise the event will carry the scope coming from the parent.

target: Option<Ref>

(Required) The destination to which the event stream is offered.

target_name: Option<String>

(Required) Name under which the event stream is being offered.

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.

Trait Implementations

impl Clone for OfferEventStream

fn clone(&self) -> OfferEventStream

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OfferEventStream

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

Formats the value using the given formatter.

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

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 OfferEventStream

fn default() -> OfferEventStream

Returns the “default value” for a type.

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

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 OfferEventStream

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

type Owned = OfferEventStream

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 OfferEventStream

type Borrowed<'a> = &'a OfferEventStream

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 OfferEventStream

impl StructuralPartialEq for OfferEventStream