Enum BatchIteratorRequest

pub enum BatchIteratorRequest {
    GetNext {
        responder: BatchIteratorGetNextResponder,
    },
    WaitForReady {
        responder: BatchIteratorWaitForReadyResponder,
    },
    _UnknownMethod {
        ordinal: u64,
        control_handle: BatchIteratorControlHandle,
        method_type: MethodType,
    },
}

Conceptually, a directory iterator, where each element in the iterator is a single complete file that can be concatenated with other results.

Variants

GetNext

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.

Fields

responder: BatchIteratorGetNextResponder

WaitForReady

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

Fields

responder: BatchIteratorWaitForReadyResponder

_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: BatchIteratorControlHandle

method_type: MethodType

Implementations

impl BatchIteratorRequest

pub fn into_get_next(self) -> Option<BatchIteratorGetNextResponder>

pub fn into_wait_for_ready(self) -> Option<BatchIteratorWaitForReadyResponder>

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

Name of the method defined in FIDL

Trait Implementations

impl Debug for BatchIteratorRequest

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

Formats the value using the given formatter.