Struct blake2b_simd::State

pub struct State { /* fields omitted */ }

An incremental hasher for BLAKE2b.

Example

use blake2b_simd::{State, blake2b};

let mut state = blake2b_simd::State::new();

state.update(b"foo");
assert_eq!(blake2b(b"foo"), state.finalize());

state.update(b"bar");
assert_eq!(blake2b(b"foobar"), state.finalize());

Methods

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(&mut 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 set_last_node(&mut self, last_node: bool) -> &mut Self

Set a flag indicating that this is the last node of its level in a tree hash. This is equivalent to Params::last_node, except that it can be set at any time before calling finalize. That allows callers to begin hashing a node without knowing ahead of time whether it's the last in its level. For more details about the intended use of this flag the BLAKE2 spec.

pub fn count(&self) -> u128

Return the total number of bytes input so far.

Trait Implementations

impl Clone for State

Important traits for State

impl Write for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Write for State

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

Write a buffer into this object, 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_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this write.

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

Creates a "by reference" adaptor for this instance of Write.

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.