Struct Keyring 

pub struct Keyring { /* private fields */ }

All of a repository’s data keys, epochs 1..=n.

Implementations

impl Keyring

pub fn new(id_key: IdKey, first: DataKey) -> Keyring

A ring holding the id key and one data key, which must be epoch 1.

pub fn generate() -> Keyring

A fresh ring: a random id key and a random epoch-1 key.

pub fn id_key(&self) -> &IdKey

The fixed id key.

pub fn truncated(&self, epoch: u32) -> Keyring

The same ring cut back to epochs 1..=epoch: what a member removed after epoch still holds. For tests and for explaining a removal.

pub fn rotate(&mut self) -> u32

Append a fresh random key as the next epoch and return its epoch.

pub fn get(&self, epoch: u32) -> Option<&DataKey>

The key for epoch.

pub fn newest(&self) -> &DataKey

The key new content is sealed under.

pub fn keys(&self) -> &[DataKey]

Every key, oldest first.

pub fn to_text(&self) -> Zeroizing<String>

The text form. Zeroed on drop.

pub fn parse(text: &str) -> Result<Keyring, KeyringError>

Parse the text form.

pub fn check_continuity(&self, newer: &Keyring) -> Result<(), ContinuityError>

Does newer extend this ring — every epoch this ring holds, with the same key? A clone that already holds a ring refuses a newer one that does not: a ring only ever grows.

Trait Implementations

impl Clone for Keyring

fn clone(&self) -> Self

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 Eq for Keyring

impl PartialEq for Keyring

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Keyring