Struct UseEventStream

pub struct UseEventStream {
    pub source_name: Option<String>,
    pub source: Option<Ref>,
    pub scope: Option<Vec<Ref>>,
    pub target_path: Option<String>,
    pub availability: Option<Availability>,
    pub filter: Option<Dictionary>,
    /* private fields */
}

Declares an EventStream used by a component.

Fields

source_name: Option<String>

(Required) The names of the event streams.

source: Option<Ref>

(Required) The provider of the event. Must be parent, framework, or child.

scope: Option<Vec<Ref>>

(Optional) When an event is used from framework, the scope is required to specify the child (or array of children) which the event will be about. When the event is used 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_path: Option<String>

(Required) The path where the capability should be installed in the component’s namespace. Must be an absolute path starting with /.

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.

filter: Option<Dictionary>

(Optional) Filter for the event stream. The structure of the filter depends on the event stream type. Only supported for the CapabilityRequested event type.

Trait Implementations

impl Clone for UseEventStream

fn clone(&self) -> UseEventStream

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UseEventStream

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

Formats the value using the given formatter.

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

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 UseEventStream

fn default() -> UseEventStream

Returns the “default value” for a type.

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

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 UseEventStream

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

type Owned = UseEventStream

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 UseEventStream

type Borrowed<'a> = &'a UseEventStream

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 UseEventStream

impl StructuralPartialEq for UseEventStream