Struct distant_net::common::authentication::Keychain

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

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

impl<T> Keychain<T>

pub fn new() -> Self

Creates a new keychain without any keys.

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.

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

Checks if there is an id stored within the keychain.

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.

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.

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.

impl Keychain<()>

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

Stores a new key by a given id`.

Trait Implementations

impl<T> Clone for Keychain<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl Default for Keychain

fn default() -> Self

Returns the “default value” for a type.

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

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

Creates a new keychain populated with the provided map.

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

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

Creates a new keychain populated with the provided map.