Struct fidl_fuchsia_component_sandbox::DictionarySynchronousProxy

pub struct DictionarySynchronousProxy { /* private fields */ }

Implementations

impl DictionarySynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event(&self, deadline: Time) -> Result<DictionaryEvent, 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 insert( &self, key: &str, value: Capability, ___deadline: Time ) -> Result<DictionaryInsertResult, Error>

Inserts a key-value pair into the dictionary.

• error DictionaryError.ALREADY_EXISTS if the dictionary already contains an item with the same key.

pub fn get( &self, key: &str, ___deadline: Time ) -> Result<DictionaryGetResult, Error>

Get a clone of a capability from this dictionary.

• error DictionaryError.NOT_FOUND if the dictionary does not contain the key.

pub fn remove( &self, key: &str, ___deadline: Time ) -> Result<DictionaryRemoveResult, Error>

Removes a key from the dictionary, returning the Capability value.

• error DictionaryError.NOT_FOUND if the dictionary does not contain the key.

pub fn read(&self, ___deadline: Time) -> Result<Vec<DictionaryItem>, Error>

Returns all items in this dictionary, sorted by key in natural order.

This operation creates shallow clones of values.

pub fn clone( &self, ___deadline: Time ) -> Result<ClientEnd<DictionaryMarker>, Error>

Creates a new connection to the same underlying dictionary.

Use Copy to a new dictionary with clones of all the exiting entries.

pub fn copy( &self, ___deadline: Time ) -> Result<ClientEnd<DictionaryMarker>, Error>

Create a new dictionary that contains a clone of all the entries in this dictionary.

For example, if this dictionary contains nested dictionaries, the newly created dictionary will contain references to those same nested dictionaries because the entries are cloned rather than copied.

pub fn enumerate( &self, contents: ServerEnd<DictionaryIteratorMarker> ) -> Result<(), Error>

Enumerates the entries in this dictionary.

Creates a clone of each item during enumeration.

pub fn drain( &self, contents: Option<ServerEnd<DictionaryIteratorMarker>> ) -> Result<(), Error>

Removes all the entries in this dictionary.

If contents is not provided, all the items are discarded without enumerating them.

Trait Implementations

impl Debug for DictionarySynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for DictionarySynchronousProxy

type Proxy = DictionaryProxy

The async proxy for the same protocol.

type Protocol = DictionaryMarker

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.