Struct fidl_fuchsia_debugdata::PublisherProxy

pub struct PublisherProxy { /* private fields */ }

Implementations

impl PublisherProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.debugdata/Publisher.

pub fn take_event_stream(&self) -> PublisherEventStream

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, data_sink: &str, data: Vmo, vmo_token: EventPair ) -> Result<(), Error>

The program runtime sends a string naming a data_sink and transfers the handle to a VMO containing the data it wants published there. The data_sink string identifies a type of data, and the VMO’s object name can specifically identify the data set in this VMO. The ZX_PROP_VMO_CONTENT_SIZE property should be set on the VMO to indicate the precise size of the data in case that is not whole pages; however, leaving it unset (i.e. 0) is acceptable when the whole-page size of the VMO is the intended size of dump. Code instrumentation runtimes use this to deliver large binary trace results. In such cases, the client can resize the VMO and should use the vmo_token handle to signal when the VMO is ready for processing by the recipient. The receiver will not process the VMO until the peer of vmo_token handle is closed. Therefore, the client should retain the peer handle until it has completed all writes to the VMO.

Trait Implementations

impl Clone for PublisherProxy

fn clone(&self) -> PublisherProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PublisherProxy

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

Formats the value using the given formatter.

impl Proxy for PublisherProxy

type Protocol = PublisherMarker

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.

impl PublisherProxyInterface for PublisherProxy

fn publish( &self, data_sink: &str, data: Vmo, vmo_token: EventPair ) -> Result<(), Error>