logo
#[non_exhaustive]
pub enum AEADAlgorithm {
    EAX,
    OCB,
    GCM,
    Private(u8),
    Unknown(u8),
}
Expand description

The AEAD algorithms as defined in Section 9.6 of RFC 4880bis.

The values can be converted into and from their corresponding values of the serialized format.

Use AEADAlgorithm::from to translate a numeric value to a symbolic one.

Note: This enum cannot be exhaustively matched to allow future extensions.

This feature is experimental.

Examples

Use AEADAlgorithm to set the preferred AEAD algorithms on a signature:

use sequoia_openpgp as openpgp;
use openpgp::packet::signature::SignatureBuilder;
use openpgp::types::{Features, HashAlgorithm, AEADAlgorithm, SignatureType};

let features = Features::empty().set_aead();
let mut builder = SignatureBuilder::new(SignatureType::DirectKey)
    .set_features(features)?
    .set_preferred_aead_algorithms(vec![
        AEADAlgorithm::EAX,
    ])?;

Variants (Non-exhaustive)

This enum is marked as 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.

EAX

EAX mode.

OCB

OCB mode.

GCM

Galois/Counter mode.

Private(u8)

Private algorithm identifier.

Unknown(u8)

Unknown algorithm identifier.

Implementations

Returns the digest size of the AEAD algorithm.

Returns the nonce size of the AEAD algorithm.

👎 Deprecated:

Use nonce_size

Returns the initialization vector size of the AEAD algorithm.

This function is deprecated. Please use AEADAlgorithm::nonce_size.

Returns whether this algorithm is supported.

Examples
use sequoia_openpgp as openpgp;
use openpgp::types::AEADAlgorithm;

assert!(! AEADAlgorithm::Private(100).is_supported());

Returns an iterator over all valid variants.

Returns an iterator over all known variants. This does not include the AEADAlgorithm::Private, or AEADAlgorithm::Unknown variants.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Formats the AEAD algorithm name.

There are two ways the AEAD algorithm name can be formatted. By default the short name is used. The alternate format uses the full algorithm name.

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::AEADAlgorithm;

// default, short format
assert_eq!("EAX", format!("{}", AEADAlgorithm::EAX));

// alternate, long format
assert_eq!("EAX mode", format!("{:#}", AEADAlgorithm::EAX));

Formats the value using the given formatter. Read more

Converts to this type from the input type.

Converts to this type from the input type.

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Restrict a value to a certain interval. Read more

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

This method tests for !=.

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

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

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

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

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

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.