Enum EncryptionAlgorithm 

#[non_exhaustive]
pub enum EncryptionAlgorithm {
    NoPadding,
    Pkcs7,
    Unknown(u8),
}

Available on crate feature encryption only.

The encryption algorithm used to encrypt the message.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

NoPadding

AES-GCM, using no padding

Pkcs7

AES-GCM, using PKCS7 padding

Unknown(u8)

Unknwon encryption version

Implementations

impl EncryptionAlgorithm

pub const fn is_no_padding(&self) -> bool

Returns true if this value is of type NoPadding. Returns false otherwise

pub const fn is_pkcs_7(&self) -> bool

Returns true if this value is of type Pkcs7. Returns false otherwise

pub const fn is_unknown(&self) -> bool

Returns true if this value is of type Unknown. Returns false otherwise

impl EncryptionAlgorithm

pub const fn as_u8(&self) -> u8

Returns the encryption version as a u8.

pub fn as_str(&self) -> Cow<'static, str>

Returns the encryption version as a &'static str.

impl EncryptionAlgorithm

pub const fn nonce_size(&self) -> usize

Returns the nonce size of the encryption algorithm

pub fn write_nonce(dst: &mut impl BufMut) -> [u8; 12]

Writes the nonce to the buffer, returning the random generated nonce

pub fn random_nonce() -> [u8; 12]

Generates a random nonce

pub fn read_nonce(src: &mut impl Buf) -> [u8; 12]

Reads the nonce from the buffer

pub fn encrypt<B>( &self, pk: SecretKey, nonce: [u8; 12], auth_data: &[u8], buf: &mut B, ) -> Result<(), EncryptionError>

where B: Buffer,

Encrypts the data using the provided secret key, nonce, and the authentication data

pub fn decrypt( &self, key: &SecretKey, nonce: &[u8], auth_data: &[u8], dst: &mut impl Buffer, ) -> Result<(), EncryptionError>

Decrypts the data using the provided secret key, nonce, and the authentication data

pub const fn encrypted_suffix_len(&self, inp: usize) -> usize

Returns the encrypted suffix length of the input size

Trait Implementations

impl Arbitrary for EncryptionAlgorithm

fn arbitrary(g: &mut Gen) -> EncryptionAlgorithm

Return an arbitrary value.

fn shrink(&self) -> Box<dyn Iterator<Item = Self>>

Return an iterator of values that are smaller than itself.

impl<'a> Arbitrary<'a> for EncryptionAlgorithm

fn arbitrary(u: &mut Unstructured<'a>) -> Result<EncryptionAlgorithm, Error>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for EncryptionAlgorithm

fn clone(&self) -> EncryptionAlgorithm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EncryptionAlgorithm

impl Debug for EncryptionAlgorithm

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

Formats the value using the given formatter.

impl Default for EncryptionAlgorithm

fn default() -> EncryptionAlgorithm

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EncryptionAlgorithm

fn deserialize<D>( deserializer: D, ) -> Result<EncryptionAlgorithm, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EncryptionAlgorithm

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

Formats the value using the given formatter.

impl Eq for EncryptionAlgorithm

impl From<u8> for EncryptionAlgorithm

fn from(value: u8) -> EncryptionAlgorithm

Converts to this type from the input type.

impl FromStr for EncryptionAlgorithm

type Err = ParseEncryptionAlgorithmError

The associated error which can be returned from parsing.

fn from_str( s: &str, ) -> Result<EncryptionAlgorithm, <EncryptionAlgorithm as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for EncryptionAlgorithm

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

where __H: Hasher,

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 PartialEq for EncryptionAlgorithm

fn eq(&self, other: &EncryptionAlgorithm) -> 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 Serialize for EncryptionAlgorithm

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EncryptionAlgorithm