Enum InspectSinkRequest

pub enum InspectSinkRequest {
    Publish {
        payload: InspectSinkPublishRequest,
        control_handle: InspectSinkControlHandle,
    },
    Escrow {
        payload: InspectSinkEscrowRequest,
        control_handle: InspectSinkControlHandle,
    },
    FetchEscrow {
        payload: InspectSinkFetchEscrowRequest,
        responder: InspectSinkFetchEscrowResponder,
    },
    _UnknownMethod {
        ordinal: u64,
        control_handle: InspectSinkControlHandle,
        method_type: MethodType,
    },
}

Variants

Publish

Publishes a handle to the fuchsia.inspect.Tree protocol that the server can use to read Inspect data, including lazy nodes.

Fields

payload: InspectSinkPublishRequest

control_handle: InspectSinkControlHandle

Escrow

Instructs the server to store the VMO provided to make its data available to Inspect readers, even when the component that published this VMO isn’t running.

This is meant to be used when integrating with Component Framework’s Escrow APIs to enable stopping when IDLE but still ensure that some useful diagnostics information is available.

The client must provide a token that will be used as a unique identifier to this VMO by the the server. This token is an event pair, a client must provide one end of this event pair and hold to the other end (or escrow the handle it using Component APIs). If the server sees a PEER_CLOSED on the handle it received, it will drop the VMO associated with this token.

If any of the required arguments isn’t passed the connection will be closed.

To learn more about stopping IDLE components, please refer to: https://fuchsia.dev/fuchsia-src/development/components/stop_idle

Fields

payload: InspectSinkEscrowRequest

control_handle: InspectSinkControlHandle

FetchEscrow

Instructs the server to return (and stop tracking) the VMO associated with the given token.

This is meant to be used when a component restarts and wants to fetch Inspect data that it escrowed.

To learn more about stopping IDLE components, please refer to: https://fuchsia.dev/fuchsia-src/development/components/stop_idle

Fields

payload: InspectSinkFetchEscrowRequest

responder: InspectSinkFetchEscrowResponder

_UnknownMethod

An interaction was received which does not match any known method.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ordinal: u64

Ordinal of the method that was called.

control_handle: InspectSinkControlHandle

method_type: MethodType

Implementations

impl InspectSinkRequest

pub fn into_publish( self, ) -> Option<(InspectSinkPublishRequest, InspectSinkControlHandle)>

pub fn into_escrow( self, ) -> Option<(InspectSinkEscrowRequest, InspectSinkControlHandle)>

pub fn into_fetch_escrow( self, ) -> Option<(InspectSinkFetchEscrowRequest, InspectSinkFetchEscrowResponder)>

pub fn method_name(&self) -> &'static str

Name of the method defined in FIDL

Trait Implementations

impl Debug for InspectSinkRequest

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

Formats the value using the given formatter.