Struct Hmac

pub struct Hmac<T: GeneralHash>(/* private fields */);

A hash computed from a RFC 2104 HMAC. Parameterized by the underlying hash function.

Trait Implementations

impl<T: GeneralHash> AsRef<[u8]> for Hmac<T>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone + GeneralHash> Clone for Hmac<T>

fn clone(&self) -> Hmac<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: GeneralHash + Debug> Debug for Hmac<T>

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

Formats the value using the given formatter.

impl<'de, T: GeneralHash + Deserialize<'de>> Deserialize<'de> for Hmac<T>

Available on crate feature serde only.

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Hmac<T>, D::Error>

Deserialize this value from the given Serde deserializer.

impl<T: GeneralHash + Display> Display for Hmac<T>

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

Formats the value using the given formatter.

impl<T: GeneralHash + FromStr> FromStr for Hmac<T>

type Err = <T as FromStr>::Err

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl<T: GeneralHash> GeneralHash for Hmac<T>

type Engine = HmacEngine<T>

A hashing engine which bytes can be serialized into. It is expected to implement the io::Write trait, and to never return errors under any conditions.

fn from_engine(e: HmacEngine<T>) -> Hmac<T>

Produces a hash from the current state of a given engine.

fn engine() -> Self::Engine

where Self::Engine: Default,

Constructs a new engine.

fn hash(data: &[u8]) -> Self

where Self::Engine: Default,

Hashes some bytes.

fn hash_byte_chunks<B, I>(byte_slices: I) -> Self

where B: AsRef<[u8]>, I: IntoIterator<Item = B>, Self::Engine: Default,

Hashes all the byte slices retrieved from the iterator together.

fn hash_reader<R: BufRead>(reader: &mut R) -> Result<Self, Error>

where Self::Engine: Default,

Available on crate feature bitcoin-io only.

Hashes the entire contents of the reader.

impl<T: Hash + GeneralHash> Hash for Hmac<T>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: GeneralHash> Hash for Hmac<T>

type Bytes = <T as Hash>::Bytes

The byte array that represents the hash internally.

fn from_byte_array(bytes: T::Bytes) -> Self

Constructs a new hash from the underlying byte array.

fn from_slice(sl: &[u8]) -> Result<Hmac<T>, FromSliceError>

👎Deprecated since 0.15.0: use from_byte_array instead

Copies a byte slice into a hash object.

fn to_byte_array(self) -> Self::Bytes

Returns the underlying byte array.

fn as_byte_array(&self) -> &Self::Bytes

Returns a reference to the underlying byte array.

const LEN: usize = <Self::Bytes>::LEN

Length of the hash, in bytes.

const DISPLAY_BACKWARD: bool = false

Flag indicating whether user-visible serializations of this hash should be backward.

impl<T: GeneralHash + LowerHex> LowerHex for Hmac<T>

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

Formats the value using the given formatter.

impl<T: Ord + GeneralHash> Ord for Hmac<T>

fn cmp(&self, other: &Hmac<T>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq + GeneralHash> PartialEq for Hmac<T>

fn eq(&self, other: &Hmac<T>) -> 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<T: PartialOrd + GeneralHash> PartialOrd for Hmac<T>

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T: GeneralHash + Serialize> Serialize for Hmac<T>

Available on crate feature serde only.

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

Serialize this value into the given Serde serializer.

impl<T: Copy + GeneralHash> Copy for Hmac<T>

impl<T: Eq + GeneralHash> Eq for Hmac<T>

impl<T: GeneralHash> StructuralPartialEq for Hmac<T>