Struct blake2b_simd::blake2bp::State

pub struct State { /* fields omitted */ }

An incremental hasher for BLAKE2bp, just like the State type for BLAKE2b.

Example

use blake2b_simd::blake2bp;

let mut state = blake2bp::State::new();
state.update(b"foo");
state.update(b"bar");
let hash = state.finalize();

let expected = "e654427b6ef02949471712263e59071abbb6aa94855674c1daeed6cfaf127c33\
                dfa3205f7f7f71e4f0673d25fa82a368488911f446bccd323af3ab03f53e56e5";
assert_eq!(expected, &hash.to_hex());

Implementations

impl State

pub fn new() -> Self

Equivalent to State::default() or Params::default().to_state().

pub fn update(&mut self, input: &[u8]) -> &mut Self

Add input to the hash. You can call update any number of times.

pub fn finalize(&self) -> Hash

Finalize the state and return a Hash. This method is idempotent, and calling it multiple times will give the same result. It’s also possible to update with more input in between.

pub fn count(&self) -> u128

Return the total number of bytes input so far.

Note that count doesn’t include the bytes of the key block, if any. It’s exactly the total number of input bytes fed to update.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl Default for State

fn default() -> Self

Returns the “default value” for a type.

impl Write for State

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.

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

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

pub 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.

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

Attempts to write an entire buffer into this writer.

pub 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.

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

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

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

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