Struct cipherstash_dynamodb::crypto::Unsealed

pub struct Unsealed { /* private fields */ }

Wrapper to which values are added prior to being encrypted. Values added as “protected” (e.g. via Unsealed::add_protected) will be encrypted. Values added as “unprotected” (e.g. via Unsealed::add_unprotected) will not be encrypted.

Implementations

impl Unsealed

pub fn new() -> Self

pub fn new_with_descriptor(descriptor: impl Into<String>) -> Self

Create a new Unsealed with a descriptor prefix.

pub fn get_plaintext(&self, name: impl Into<AttributeName>) -> TableAttribute

👎Deprecated since 0.7.3: Use Unsealed::take_unprotected instead

pub fn add_protected( &mut self, name: impl Into<String>, plaintext: impl Into<Plaintext>, )

Add a new protected attribute, name, with the given plaintext.

pub fn add_protected_map( &mut self, name: impl Into<String>, map: HashMap<String, Plaintext>, )

Add a new protected map, name, with the given map of plaintexts.

pub fn add_protected_map_field( &mut self, name: impl Into<String>, subkey: impl Into<String>, value: impl Into<Plaintext>, )

Insert a new key-value pair into a map stored in the protected attributes, name. If the map does not exist, it will be created. If the map exists, the key-value pair will be updated. If an attribute called name already exists but is not a map, this will panic.

pub fn add_unprotected( &mut self, name: impl Into<AttributeName>, attribute: impl Into<TableAttribute>, )

Add a new unprotected attribute, name, with the given plaintext.

pub fn take_unprotected( &mut self, name: impl Into<AttributeName>, ) -> TableAttribute

Removes and returns the unprotected attribute, name. See also TableAttribute.

If the attribute does not exist, TableAttribute::Null is returned.

pub fn take_protected(&mut self, name: &str) -> Option<Plaintext>

Removes and returns the protected attribute, name.

pub fn take_protected_map( &mut self, name: &str, ) -> Option<HashMap<String, Plaintext>>

Removes and returns the map stored in the protected attributes, name. The caller can convert to whatever type they need.

pub fn into_value<T: Decryptable>(self) -> Result<T, SealError>

Convert self into T using the attributes stored in self. The Decryptable trait must be implemented for T and this method calls Decryptable::from_unsealed.

Trait Implementations

impl Default for Unsealed

fn default() -> Self

Returns the “default value” for a type.