Struct bitcoin_hashes::hmac::HmacEngine

pub struct HmacEngine<T: Hash> { /* private fields */ }

Pair of underlying hash engines, used for the inner and outer hash of HMAC.

Implementations

impl<T: Hash> HmacEngine<T>

pub fn new(key: &[u8]) -> HmacEngine<T>

Constructs a new keyed HMAC from key.

We only support underlying hashes whose block sizes are ≤ 128 bytes.

Panics

Larger hashes will result in a panic.

pub fn from_inner_engines( iengine: T::Engine, oengine: T::Engine ) -> HmacEngine<T>

A special constructor giving direct access to the underlying “inner” and “outer” engines.

Trait Implementations

impl<T: Clone + Hash> Clone for HmacEngine<T>

where T::Engine: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Hash> Default for HmacEngine<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Hash> HashEngine for HmacEngine<T>

type MidState = HmacMidState<T>

Byte array representing the internal state of the hash engine.

fn midstate(&self) -> Self::MidState

Outputs the midstate of the hash engine. This function should not be used directly unless you really know what you’re doing.

const BLOCK_SIZE: usize = <T::Engine>::BLOCK_SIZE

Length of the hash’s internal block size, in bytes.

fn n_bytes_hashed(&self) -> usize

Return the number of bytes already n_bytes_hashed(inputted).

fn input(&mut self, buf: &[u8])

Add data to the hash engine.

impl<T: Hash> Write for HmacEngine<T>

Available on crate feature bitcoin-io only.

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

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

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.

impl<T: Hash> Write for HmacEngine<T>

Available on crate feature bitcoin-io only.

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes buf into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.