Struct Dictionary 

pub struct Dictionary { /* private fields */ }

A capability that represents a dictionary of capabilities.

Implementations

impl Dictionary

pub fn new() -> Self

Creates an empty dictionary.

pub fn new_with_not_found( not_found: impl Fn(&str) + 'static + Send + Sync, ) -> Self

Creates an empty dictionary. When an external request tries to access a non-existent entry, the name of the entry will be sent using not_found.

pub fn register_update_notifier(&self, notifier_fn: UpdateNotifierFn)

Registers a new update notifier function with this dictionary. The function will be called whenever an entry is added to or removed from this dictionary. The function will be immediately called with an EntryUpdate::Add value for any entries already in this dictionary.

Note that this function will be called while the internal dictionary structure is locked, so it must not interact with the dictionary on which it is registered. It shouldn’t even hold a strong reference to the dictionary it’s registered on, as that’ll create a cycle and make LSAN sad.

pub fn insert( &self, key: Key, capability: Capability, ) -> Result<(), CapabilityStoreError>

Inserts an entry, mapping key to capability. If an entry already exists at key, a fsandbox::DictionaryError::AlreadyExists will be returned.

pub fn append(&self, other: &Dictionary) -> Result<(), ()>

pub fn get<Q>(&self, key: &Q) -> Option<Capability>

where Key: Borrow<Q> + Ord, Q: Ord + ?Sized,

Returns a clone of the capability associated with key. If there is no entry for key, None is returned.

pub fn get_or_insert( &self, key: &Key, default: impl FnOnce() -> Capability, ) -> Capability

Returns a clone of the capability associated with key, or populates it with default if it is not present.

pub fn remove(&self, key: &BorrowedName) -> Option<Capability>

Removes key from the entries, returning the capability at key if the key was already in the entries.

pub fn enumerate(&self) -> impl Iterator<Item = (Key, Capability)> + use<>

Returns an iterator over a clone of the entries, sorted by key.

pub fn snapshot_keys_as_strings(&self) -> Vec<String>

Returns the keys.

pub fn is_empty(&self) -> bool

Returns if entries is empty.

pub fn drain(&self) -> impl Iterator<Item = (Key, Capability)> + use<>

Removes all entries from the Dictionary and returns them as an iterator.

pub fn shallow_copy(&self) -> Result<Self, ()>

Creates a new Dictionary with entries cloned from this Dictionary.

This is a shallow copy. Values are cloned, not copied, so are new references to the same underlying data.

If any value in the dictionary could not be cloned, returns an error.

impl Dictionary

pub fn try_into_directory_entry_oneshot( self, scope: ExecutionScope, token: WeakInstanceToken, ) -> Result<Arc<dyn DirectoryEntry>, ConversionError>

Like RemotableCapability::try_into_directory_entry, but this version actually consumes the contents of the Dictionary. In other words, if this function returns Ok, self will be empty. If any items are added to self later, they will not appear in the directory. This method is useful when the caller has no need to keep the original Dictionary. Note that even if there is only one reference to the Dictionary, calling RemotableCapability::try_into_directory_entry does not have the same effect because the vfs keeps alive reference to the Dictionary – see the comment in the implementation.

This is transitive: any Dictionarys nested in this one will be consumed as well.

Trait Implementations

impl CapabilityBound for Dictionary

fn debug_typename() -> &'static str

impl Clone for Dictionary

fn clone(&self) -> Dictionary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dictionary

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

Formats the value using the given formatter.

impl Default for Dictionary

fn default() -> Self

Returns the “default value” for a type.

impl From<Dictionary> for Capability

fn from(f: Dictionary) -> Self

Converts to this type from the input type.

impl From<Dictionary> for DictionaryRef

fn from(dict: Dictionary) -> Self

Converts to this type from the input type.

impl FromEnum<Capability> for Dictionary

fn from_enum(e: &Capability) -> Option<&Self>

impl IntoFsandboxCapability for Dictionary

fn into_fsandbox_capability(self, _token: WeakInstanceToken) -> Capability

impl RemotableCapability for Dictionary

fn try_into_directory_entry( self, scope: ExecutionScope, token: WeakInstanceToken, ) -> Result<Arc<dyn DirectoryEntry>, ConversionError>

Attempt to convert self to a DirectoryEntry which can be served in a VFS. If routing needs to be performed, token should be the WeakInstanceToken used for the route.

impl TryFrom<Capability> for Dictionary

type Error = ()

The type returned in the event of a conversion error.

fn try_from(c: Capability) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Channel> for Dictionary

type Error = RemoteError

The type returned in the event of a conversion error.

fn try_from(dict: Channel) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<DictionaryRef> for Dictionary

type Error = RemoteError

The type returned in the event of a conversion error.

fn try_from(dict: DictionaryRef) -> Result<Self, Self::Error>

Performs the conversion.