Trait DictionaryEnumerateIteratorServerHandler

Source
pub trait DictionaryEnumerateIteratorServerHandler<___T: Transport> {
    // Required method
    fn get_next(
        &mut self,
        sender: &ServerSender<___T, DictionaryEnumerateIterator>,
        request: RequestBuffer<___T, GetNext>,
        responder: Responder<GetNext>,
    );

    // Provided method
    fn on_unknown_interaction(
        &mut self,
        sender: &ServerSender<___T, DictionaryEnumerateIterator>,
        ordinal: u64,
    ) { ... }
}
Expand description

A server handler for the DictionaryEnumerateIterator protocol.

See DictionaryEnumerateIterator for more details.

Required Methods§

Source

fn get_next( &mut self, sender: &ServerSender<___T, DictionaryEnumerateIterator>, request: RequestBuffer<___T, GetNext>, responder: Responder<GetNext>, )

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

The value of each of items is a duplicate of the original capability ([CapabilityStore.Duplicate]), unless it could not be duplicated, it which case it will be null.

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.

Provided Methods§

Source

fn on_unknown_interaction( &mut self, sender: &ServerSender<___T, DictionaryEnumerateIterator>, ordinal: u64, )

Implementors§