Struct snapper_box::crypto::types::ClearText

pub struct ClearText { /* fields omitted */ }

An unencrypted blob of plaintext.

This type exists to facilitate marshaling data to a serialized, encrypted, representation

Implementations

impl ClearText

pub fn new<T>(item: &T) -> Result<Self, Error> where
    T: Serialize, 

Creates a new Cleartext from a serializeable object

Errors

Will return an error if serialization fails

pub fn encrypt<K>(
    self,
    key: &K,
    compression: Option<i32>
) -> Result<CipherText<'static>, Error> where
    K: Key, 

Attempts to create an encrypted version of this Cleartext using the provided key. ZStd compression will be applied to the plain text before encryption with the provided level, if the compression option is set with a Some value.

DANGER

Compression can be incredibly dangerous when combined with encryption, do not set the compression flag unless you know what you are doing, and you are 100% sure that compression related attacks do not fall into your threat model.

Errors

Will return an error if encryption fails.

pub fn deserialize<T>(&self) -> Result<T, Error> where
    T: DeserializeOwned, 

Converts this Cleartext back into its original type.

Errors

Will return Err(Error::ItemDeserialization) if the serialization. Be warned, since this intentionally erases the underlying serde error, it can be difficult to tell if this is due to data corruption, or simply calling this method with the wrong type argument.

Trait Implementations

impl Clone for ClearText

fn clone(&self) -> ClearText

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for ClearText

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Drop for ClearText

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for ClearText

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for ClearText

fn cmp(&self, other: &ClearText) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<ClearText> for ClearText

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<ClearText> for ClearText

fn partial_cmp(&self, other: &ClearText) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for ClearText

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

Serialize this value into the given Serde serializer.

impl Zeroize for ClearText

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl Eq for ClearText

impl StructuralEq for ClearText

impl StructuralPartialEq for ClearText