Struct fidl_fuchsia_io::DirectoryIteratorProxy

pub struct DirectoryIteratorProxy { /* private fields */ }

Implementations

impl DirectoryIteratorProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for DirectoryIterator

pub fn take_event_stream(&self) -> DirectoryIteratorEventStream

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

Panics

Panics if the event stream was already taken.

pub fn get_next(&self) -> QueryResponseFut<DirectoryIteratorGetNextResult>

Reads a collection of variably sized directory entries into a buffer.

The number of entries in a directory may be very large: akin to calling read multiple times on a file, directories have a seek offset which is updated on subsequent calls to Enumerate. The caller should always use a receiving buffer size as large as the maximum channel limit.

When the end of iteration is reached, the returned entries vector will be empty.

This method does not require any rights, as the rights are checked in the [Directory.Enumerate] call.

Trait Implementations

impl Clone for DirectoryIteratorProxy

fn clone(&self) -> DirectoryIteratorProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DirectoryIteratorProxy

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

Formats the value using the given formatter.

impl DirectoryIteratorProxyInterface for DirectoryIteratorProxy

type GetNextResponseFut = QueryResponseFut<Result<Vec<DirectoryEntry, Global>, i32>>

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

impl Proxy for DirectoryIteratorProxy

type Protocol = DirectoryIteratorMarker

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 is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed<'a>(&'a self) -> OnSignals<'a>

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