Struct InspectSinkProxy

pub struct InspectSinkProxy { /* private fields */ }

Implementations

impl InspectSinkProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.inspect/InspectSink.

pub fn take_event_stream(&self) -> InspectSinkEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn publish(&self, payload: InspectSinkPublishRequest) -> Result<(), Error>

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

pub fn escrow(&self, payload: InspectSinkEscrowRequest) -> Result<(), Error>

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

pub fn fetch_escrow( &self, payload: InspectSinkFetchEscrowRequest, ) -> QueryResponseFut<InspectSinkFetchEscrowResponse, DefaultFuchsiaResourceDialect>

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

Trait Implementations

impl Clone for InspectSinkProxy

fn clone(&self) -> InspectSinkProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InspectSinkProxy

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

Formats the value using the given formatter.

impl InspectSinkProxyInterface for InspectSinkProxy

type FetchEscrowResponseFut = QueryResponseFut<InspectSinkFetchEscrowResponse>

fn publish(&self, payload: InspectSinkPublishRequest) -> Result<(), Error>

fn escrow(&self, payload: InspectSinkEscrowRequest) -> Result<(), Error>

fn fetch_escrow( &self, payload: InspectSinkFetchEscrowRequest, ) -> Self::FetchEscrowResponseFut

impl Proxy for InspectSinkProxy

type Protocol = InspectSinkMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.