Struct CipherText 

pub struct CipherText<'a> { /* private fields */ }

An encrypted plaintext, with associated data

This structure contains the payload, encrypted with XChaCha20, the nonce that was used to encrypt it, as well as the HMAC of the encrypted payload. It also includes a flag indicating whether or not to treat the plaintext as compressed

Implementations

impl CipherText<'_>

pub fn decrypt<K>(&self, key: &K) -> Result<ClearText, BackendError>

where K: Key,

Attempts to decrypt the Ciphertext with the given key, turning it into a Cleartext. This will also decompress the payload, if it was compressed.

Errors

Will return:

• Error::BadHMAC - If the hmac tag fails to validate (decryption failure)
• Error::Decompression - If compressed data fails to decompress

pub fn compressed(&self) -> bool

Returns true if this CipherText is compressed

Trait Implementations

impl<'a> Clone for CipherText<'a>

fn clone(&self) -> CipherText<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CipherText<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for CipherText<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> Hash for CipherText<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for CipherText<'a>

fn cmp(&self, other: &CipherText<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for CipherText<'a>

fn eq(&self, other: &CipherText<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd for CipherText<'a>

fn partial_cmp(&self, other: &CipherText<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Serialize for CipherText<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for CipherText<'a>

impl<'a> StructuralPartialEq for CipherText<'a>