Struct InspectSinkEscrowRequest

pub struct InspectSinkEscrowRequest {
    pub vmo: Option<Vmo>,
    pub token: Option<EscrowToken>,
    pub name: Option<String>,
    pub tree: Option<u64>,
    /* private fields */
}

Fields

vmo: Option<Vmo>

The VMO containing Inspect data that the server will store. Required

token: Option<EscrowToken>

The token identifying this VMO and also serving as a controller to stop storing this VMO in the server. Required

name: Option<String>

An optional name to identify this VMO, that can be human readable.

Optional

tree: Option<u64>

An optional reference to the Tree that was previously provided to the server using Publish. The server will drop the handle associated with that tree connection, triggering a peer closed on the tree server. This enables the client to ensure the following:

• Tree data and escrowed data won’t be present twice in snapshots.
• The caller can know when to stop serving the tree, preventing data missing from snapshots.

If name isn’t provided, the name of this Inspect will be the one associated with this tree.

If the server isn’t tracking any handle associated with the source component with this koid, this will be ignored and treated as if nothing had been provided.

Optional

Trait Implementations

impl Debug for InspectSinkEscrowRequest

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

Formats the value using the given formatter.

impl Decode<InspectSinkEscrowRequest, DefaultFuchsiaResourceDialect> for InspectSinkEscrowRequest

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 InspectSinkEscrowRequest

fn default() -> InspectSinkEscrowRequest

Returns the “default value” for a type.

impl Encode<InspectSinkEscrowRequest, DefaultFuchsiaResourceDialect> for &mut InspectSinkEscrowRequest

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 InspectSinkEscrowRequest

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

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

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 InspectSinkEscrowRequest

type Owned = InspectSinkEscrowRequest

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 InspectSinkEscrowRequest

impl StructuralPartialEq for InspectSinkEscrowRequest