Struct Keychain

Source
pub struct Keychain<T = ()> { /* private fields */ }
Expand description

Manages keys with associated ids. Cloning will result in a copy pointing to the same underlying storage, which enables support of managing the keys across multiple threads.

Implementations§

Source§

impl<T> Keychain<T>

Source

pub fn new() -> Self

Creates a new keychain without any keys.

Source

pub async fn insert( &self, id: impl Into<String>, key: HeapSecretKey, data: T, ) -> Option<T>

Stores a new key and data by a given id, returning the old data associated with the id if there was one already registered.

Source

pub async fn has_id(&self, id: impl AsRef<str>) -> bool

Checks if there is an id stored within the keychain.

Source

pub async fn has_key( &self, id: impl AsRef<str>, key: impl PartialEq<HeapSecretKey>, ) -> bool

Checks if there is a key with the given id that matches the provided key.

Source

pub async fn remove(&self, id: impl AsRef<str>) -> Option<T>

Removes a key and its data by a given id, returning the data if the id exists.

Source

pub async fn remove_if_has_key( &self, id: impl AsRef<str>, key: impl PartialEq<HeapSecretKey>, ) -> KeychainResult<T>

Checks if there is a key with the given id that matches the provided key, returning the data if the id exists and the key matches.

Source§

impl Keychain<()>

Source

pub async fn put(&self, id: impl Into<String>, key: HeapSecretKey)

Stores a new key by a given id`.

Trait Implementations§

Source§

impl<T> Clone for Keychain<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for Keychain<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Keychain

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<T> From<HashMap<String, (HeapSecretKey, T)>> for Keychain<T>

Source§

fn from(map: HashMap<String, (HeapSecretKey, T)>) -> Self

Creates a new keychain populated with the provided map.

Source§

impl From<HashMap<String, HeapSecretKey>> for Keychain<()>

Source§

fn from(map: HashMap<String, HeapSecretKey>) -> Self

Creates a new keychain populated with the provided map.

Auto Trait Implementations§

§

impl<T> Freeze for Keychain<T>

§

impl<T = ()> !RefUnwindSafe for Keychain<T>

§

impl<T> Send for Keychain<T>
where T: Send + Sync,

§

impl<T> Sync for Keychain<T>
where T: Send + Sync,

§

impl<T> Unpin for Keychain<T>

§

impl<T = ()> !UnwindSafe for Keychain<T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AsAny for T
where T: 'static,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts reference to Any
Source§

fn as_mut_any(&mut self) -> &mut (dyn Any + 'static)

Converts mutable reference to Any
Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Consumes and produces Box<dyn Any>
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V