Struct tink_core::primitiveset::PrimitiveSet

pub struct PrimitiveSet {
    pub primary: Option<Entry>,
    pub entries: HashMap<Vec<u8>, Vec<Entry>>,
}

PrimitiveSet is used for supporting key rotation: primitives in a set correspond to keys in a keyset. Users will usually work with primitive instances, which essentially wrap primitive sets. For example an instance of an AEAD-primitive for a given keyset holds a set of AEAD-primitives corresponding to the keys in the keyset, and uses the set members to do the actual crypto operations: to encrypt data the primary AEAD-primitive from the set is used, and upon decryption the ciphertext's prefix determines the id of the primitive from the set.

PrimitiveSet is public to allow its use in implementations of custom primitives.

Fields

primary: Option<Entry>

entries: HashMap<Vec<u8>, Vec<Entry>>

Implementations

impl PrimitiveSet

pub fn new() -> Self

Return an empty instance of PrimitiveSet.

pub fn raw_entries(&self) -> Vec<Entry>

Return all primitives in the set that have RAW prefix.

pub fn entries_for_prefix(&self, prefix: &[u8]) -> Vec<Entry>

Return all primitives in the set that have the given prefix.

pub fn add(&mut self, p: Primitive, key: &Key) -> Result<Entry, TinkError>

Create a new entry in the primitive set and returns a copy of the added entry.

Trait Implementations

impl Clone for PrimitiveSet

fn clone(&self) -> PrimitiveSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for PrimitiveSet

fn default() -> PrimitiveSet

Returns the "default value" for a type.

impl<P: From<Primitive>> From<PrimitiveSet> for TypedPrimitiveSet<P>

Convert an untyped PrimitiveSet into a TypedPrimitiveSet. This will panic if any of the primitives are not of the correct type.

fn from(ps: PrimitiveSet) -> Self

Performs the conversion.