Enum GlobalKeys

pub(crate) enum GlobalKeys<'a, Ids: KeyIds> {
    ReadOnly(RwLockReadGuard<'a, KeyStoreInner<Ids>>),
    ReadWrite(RwLockWriteGuard<'a, KeyStoreInner<Ids>>),
}

A KeyStoreContext is usually limited to a read only access to the global keys, which allows us to have multiple read only contexts at the same time and do multitheaded encryption/decryption. We also have the option to create a read/write context, which allows us to modify the global keys, but only allows one context at a time. This is controlled by a std::sync::RwLock on the global keys, and this struct stores both types of guards.

Variants

ReadOnly(RwLockReadGuard<'a, KeyStoreInner<Ids>>)

ReadWrite(RwLockWriteGuard<'a, KeyStoreInner<Ids>>)

Implementations

impl<Ids: KeyIds> GlobalKeys<'_, Ids>

pub fn get(&self) -> &KeyStoreInner<Ids>

Get a shared reference to the underlying KeyStoreInner.

This returns a shared reference regardless of whether the global keys were locked for read-only or read-write access. Callers who need mutable access should use get_mut which will return an error when the context is read-only.

pub fn get_mut(&mut self) -> Result<&mut KeyStoreInner<Ids>, CryptoError>

Get a mutable reference to the underlying KeyStoreInner.

This will succeed only when the context was created with write access. If the context is read-only an error (CryptoError::ReadOnlyKeyStore) is returned.

Errors

Returns CryptoError::ReadOnlyKeyStore when attempting to get mutable access from a read-only context.