Struct ComponentControllerOnEscrowRequest 

pub struct ComponentControllerOnEscrowRequest {
    pub outgoing_dir: Option<ServerEnd<DirectoryMarker>>,
    pub escrowed_dictionary: Option<DictionaryRef>,
    pub escrowed_dictionary_handle: Option<EventPair>,
    /* private fields */
}

Fields

outgoing_dir: Option<ServerEnd<DirectoryMarker>>

Escrow the outgoing directory server endpoint. Whenever the component is started, the framework will return this channel via [ComponentStartInfo.outgoing_dir].

escrowed_dictionary: Option<DictionaryRef>

Escrow some user defined state. Whenever the component is started, the framework will return these handles via [ComponentStartInfo.escrowed_dictionary].

The framework will not wait for any signals on these objects.

Example

Let’s say a component needs to escrow an event pair that represents the result of some expensive calculation. It can create a dictionary, put the event pair inside with an appropriate key (e.g. "my_event_pair"), then check for that entry on startup. Note that this is deprecated, please use escrowed_dictionary_handle instead.

escrowed_dictionary_handle: Option<EventPair>

Escrow some user defined state. Whenever the component is started, the framework will return these handles via [ComponentStartInfo.escrowed_dictionary].

The framework will not wait for any signals on these objects.

Example

Let’s say a component needs to escrow an event pair that represents the result of some expensive calculation. It can create a dictionary, put the event pair inside with an appropriate key (e.g. "my_event_pair"), then check for that entry on startup.

Trait Implementations

impl Debug for ComponentControllerOnEscrowRequest

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

Formats the value using the given formatter.

impl Decode<ComponentControllerOnEscrowRequest, DefaultFuchsiaResourceDialect> for ComponentControllerOnEscrowRequest

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<'_, DefaultFuchsiaResourceDialect>, offset: usize, depth: Depth, ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl Default for ComponentControllerOnEscrowRequest

fn default() -> ComponentControllerOnEscrowRequest

Returns the “default value” for a type.

impl Encode<ComponentControllerOnEscrowRequest, DefaultFuchsiaResourceDialect> for &mut ComponentControllerOnEscrowRequest

unsafe fn encode( self, encoder: &mut Encoder<'_, DefaultFuchsiaResourceDialect>, 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 ComponentControllerOnEscrowRequest

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

type Borrowed<'a> = &'a mut ComponentControllerOnEscrowRequest

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &mut Self::Owned. There are three cases:

fn take_or_borrow<'a>( value: &'a mut <Self as TypeMarker>::Owned, ) -> Self::Borrowed<'a>

Cheaply converts from &mut Self::Owned to Self::Borrowed. For HandleBased types this is “take” (it returns an owned handle and replaces value with Handle::invalid), and for all other types it is “borrow” (just converts from one reference to another).

impl TypeMarker for ComponentControllerOnEscrowRequest

type Owned = ComponentControllerOnEscrowRequest

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 Standalone<DefaultFuchsiaResourceDialect> for ComponentControllerOnEscrowRequest

impl StructuralPartialEq for ComponentControllerOnEscrowRequest