Struct BatchIteratorProxy

pub struct BatchIteratorProxy { /* private fields */ }

Implementations

impl BatchIteratorProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.diagnostics/BatchIterator.

pub fn take_event_stream(&self) -> BatchIteratorEventStream

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

Panics

Panics if the event stream was already taken.

pub fn get_next( &self, ) -> QueryResponseFut<BatchIteratorGetNextResult, DefaultFuchsiaResourceDialect>

Returns a vector of [fuchsia.diagnostics/FormattedContent] structs with a format dictated by the format_settings argument provided to the Reader protocol which spawned this BatchIterator.

An empty vector implies that the data hierarchy has been fully iterated, and subsequent GetNext calls will always return the empty vector.

When the BatchIterator is serving results via subscription model, calls to GetNext will hang until there is new data available, it will not return an empty vector.

• returns a vector of FormattedContent structs. Clients connected to a Batch are expected to call GetNext() until an empty vector is returned, denoting that the entire data hierarchy has been read.

• error a [fuchsia.diagnostics/ReaderError] value indicating that there was an issue reading the underlying data hierarchies or formatting those hierarchies to populate the batch. Note, these issues do not include a single component’s data hierarchy failing to be read. The iterator is tolerant of individual component data sources failing to be read, whether that failure is a timeout or a malformed binary file. In the event that a GetNext call fails, that subset of the data hierarchy results is dropped, but future calls to GetNext will provide new subsets of FormattedDataHierarchies.

pub fn wait_for_ready( &self, ) -> QueryResponseFut<(), DefaultFuchsiaResourceDialect>

Indiciates that the BatchIterator has been connected. If the BatchIterator hasn’t been connected, this method will hang until it is.

Trait Implementations

impl BatchIteratorProxyInterface for BatchIteratorProxy

type GetNextResponseFut = QueryResponseFut<Result<Vec<FormattedContent>, ReaderError>>

type WaitForReadyResponseFut = QueryResponseFut<()>

fn get_next(&self) -> Self::GetNextResponseFut

fn wait_for_ready(&self) -> Self::WaitForReadyResponseFut

impl Clone for BatchIteratorProxy

fn clone(&self) -> BatchIteratorProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BatchIteratorProxy

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

Formats the value using the given formatter.

impl Proxy for BatchIteratorProxy

type Protocol = BatchIteratorMarker

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.