Struct DictionaryDrainIteratorProxy

pub struct DictionaryDrainIteratorProxy { /* private fields */ }

Implementations

impl DictionaryDrainIteratorProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.component.sandbox/DictionaryDrainIterator.

pub fn take_event_stream(&self) -> DictionaryDrainIteratorEventStream

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, start_id: u64, limit: u32, ) -> QueryResponseFut<DictionaryDrainIteratorGetNextResult, DefaultFuchsiaResourceDialect>

Returns the next batch of results for a [Dictionary.Drain] call, returning up to limit results. limit can be at most MAX_DICTIONARY_ITERATOR_CHUNK.

Each returned capability will be assigned a monotonically increasing CapabilityId starting from start_id.

In addition to the items, returns end_id, which is one more than the highest id reserved by [GetNext]. end_id can be used as the start_id for the next call to [GetNext].

If [GetNext] returns an error, the server will also close the channel.

Errors:

• ID_ALREADY_EXISTS if some id in the range [start_id, limit) already exists in this store.
• INVALID_ARGS if limit was 0 or greater than MAX_DICTIONARY_ITERATOR_CHUNK.

Trait Implementations

impl Clone for DictionaryDrainIteratorProxy

fn clone(&self) -> DictionaryDrainIteratorProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DictionaryDrainIteratorProxy

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

Formats the value using the given formatter.

impl DictionaryDrainIteratorProxyInterface for DictionaryDrainIteratorProxy

type GetNextResponseFut = QueryResponseFut<Result<(Vec<DictionaryItem>, u64), CapabilityStoreError>>

fn get_next(&self, start_id: u64, limit: u32) -> Self::GetNextResponseFut

impl Proxy for DictionaryDrainIteratorProxy

type Protocol = DictionaryDrainIteratorMarker

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.