Struct DictionaryDrainIteratorSynchronousProxy

pub struct DictionaryDrainIteratorSynchronousProxy { /* private fields */ }

Implementations

impl DictionaryDrainIteratorSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<DictionaryDrainIteratorEvent, Error>

Waits until an event arrives and returns it. It is safe for other threads to make concurrent requests while waiting for an event.

pub fn get_next( &self, start_id: u64, limit: u32, ___deadline: MonotonicInstant, ) -> Result<DictionaryDrainIteratorGetNextResult, Error>

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 Debug for DictionaryDrainIteratorSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for DictionaryDrainIteratorSynchronousProxy

type Proxy = DictionaryDrainIteratorProxy

The async proxy for the same protocol.

type Protocol = DictionaryDrainIteratorMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Channel

Convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> Result<bool, Status>

Returns true if the proxy has received the PEER_CLOSED signal.