Enum sequoia_openpgp::types::HashAlgorithm[][src]

#[non_exhaustive]
pub enum HashAlgorithm {
    MD5,
    SHA1,
    RipeMD,
    SHA256,
    SHA384,
    SHA512,
    SHA224,
    Private(u8),
    Unknown(u8),
}
Expand description

The OpenPGP hash algorithms as defined in Section 9.4 of RFC 4880.

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

Examples

Use HashAlgorithm to set the preferred hash algorithms on a signature:

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

let mut builder = SignatureBuilder::new(SignatureType::DirectKey)
    .set_hash_algo(HashAlgorithm::SHA512);

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.

MD5

Rivest et.al. message digest 5.

SHA1

NIST Secure Hash Algorithm (deprecated)

RipeMD

RIPEMD-160

SHA256

256-bit version of SHA2

SHA384

384-bit version of SHA2

SHA512

512-bit version of SHA2

SHA224

224-bit version of SHA2

Private(u8)

Tuple Fields

0: u8

Private hash algorithm identifier.

Unknown(u8)

Tuple Fields

0: u8

Unknown hash algorithm identifier.

Implementations

Whether Sequoia supports this algorithm.

Returns the ASN.1 OID of this hash algorithm.

Creates a new hash context for this algorithm.

Errors

Fails with Error::UnsupportedHashAlgorithm if Sequoia does not support this algorithm. See HashAlgorithm::is_supported.

Returns the text name of this algorithm.

Section 9.4 of RFC 4880 defines a textual representation of hash algorithms. This is used in cleartext signed messages (see Section 7 of RFC 4880).

Examples
assert_eq!(HashAlgorithm::RipeMD.text_name()?, "RIPEMD160");

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 value using the given formatter. Read more

Performs the conversion.

Performs the conversion.

The associated error which can be returned from parsing.

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

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

Performs the conversion.

Performs the conversion.

Should always be Self

The resulting type after obtaining ownership.

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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.