Struct Keyring 

pub struct Keyring { /* private fields */ }

Available on crate feature encryption only.

A lock-free and thread-safe container for a set of encryption keys. The keyring contains all key data used internally by memberlist.

If creating a keyring with multiple keys, one key must be designated primary by passing it as the primaryKey. If the primaryKey does not exist in the list of secondary keys, it will be automatically added at position 0.

Implementations

impl Keyring

pub fn new(primary_key: SecretKey) -> Self

Constructs a new container for a primary key. The keyring contains all key data used internally by memberlist.

If only a primary key is passed, then it will be automatically added to the keyring.

A key should be either 16, 24, or 32 bytes to select AES-128, AES-192, or AES-256.

pub fn with_keys( primary_key: SecretKey, keys: impl Iterator<Item = impl Into<SecretKey>>, ) -> Self

Constructs a new container for a set of encryption keys. The keyring contains all key data used internally by memberlist.

If only a primary key is passed, then it will be automatically added to the keyring. If creating a keyring with multiple keys, one key must be designated primary by passing it as the primaryKey. If the primaryKey does not exist in the list of secondary keys, it will be automatically added.

A key should be either 16, 24, or 32 bytes to select AES-128, AES-192, or AES-256.

pub fn primary_key(&self) -> SecretKey

Returns the key on the ring at position 0. This is the key used for encrypting messages, and is the first key tried for decrypting messages.

pub fn remove(&self, key: &[u8]) -> Result<(), KeyringError>

Drops a key from the keyring. This will return an error if the key requested for removal is currently at position 0 (primary key).

pub fn insert(&self, key: SecretKey)

Install a new key on the ring. Adding a key to the ring will make it available for use in decryption. If the key already exists on the ring, this function will just return noop.

key should be either 16, 24, or 32 bytes to select AES-128, AES-192, or AES-256.

pub fn use_key(&self, key_data: &[u8]) -> Result<(), KeyringError>

Changes the key used to encrypt messages. This is the only key used to encrypt messages, so peers should know this key before this method is called.

pub fn keys(&self) -> impl Iterator<Item = SecretKey> + Send + 'static

Returns the current set of keys on the ring.

Trait Implementations

impl Clone for Keyring

fn clone(&self) -> Keyring

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Keyring

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Keyring

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Keyring

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.