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

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

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)

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)

Private hash algorithm identifier.

Unknown(u8)

Unknown hash algorithm identifier.

Implementations

impl HashAlgorithm[src]

pub fn is_supported(self) -> bool[src]

Whether Sequoia supports this algorithm.

pub fn oid(self) -> Result<&'static [u8]>[src]

Returns the ASN.1 OID of this hash algorithm.

impl HashAlgorithm[src]

pub fn context(self) -> Result<Context>[src]

Creates a new hash context for this algorithm.

Errors

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

Trait Implementations

impl Clone for HashAlgorithm[src]

impl Copy for HashAlgorithm[src]

impl Debug for HashAlgorithm[src]

impl Default for HashAlgorithm[src]

impl Display for HashAlgorithm[src]

impl Eq for HashAlgorithm[src]

impl From<HashAlgorithm> for u8[src]

impl From<u8> for HashAlgorithm[src]

impl FromStr for HashAlgorithm[src]

type Err = ()

The associated error which can be returned from parsing.

impl Hash for HashAlgorithm[src]

impl Ord for HashAlgorithm[src]

impl PartialEq<HashAlgorithm> for HashAlgorithm[src]

impl PartialOrd<HashAlgorithm> for HashAlgorithm[src]

impl StructuralEq for HashAlgorithm[src]

impl StructuralPartialEq for HashAlgorithm[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> DynClone for T where
    T: Clone
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> ToString for T where
    T: Display + ?Sized
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.