Struct BlockBuffer 

pub struct BlockBuffer<BS: BlockSizes, K: BufferKind> {
    pub(crate) buffer: MaybeUninit<Array<u8, BS>>,
    pub(crate) pos: K::Pos,
}

Buffer for block processing of data.

Fields

buffer: MaybeUninit<Array<u8, BS>>

pos: K::Pos

Implementations

impl<BS: BlockSizes, K: BufferKind> BlockBuffer<BS, K>

pub fn new(buf: &[u8]) -> Self

Create new buffer from slice.

Panics

If slice length is not valid for used buffer kind.

pub fn try_new(buf: &[u8]) -> Result<Self, Error>

Create new buffer from slice.

Errors

If slice length is not valid for used buffer kind.

pub fn digest_blocks( &mut self, input: &[u8], compress: impl FnMut(&[Array<u8, BS>]), )

Digest data in input in blocks of size BlockSize using the compress function, which accepts slice of blocks.

pub fn reset(&mut self)

Reset buffer by setting cursor position to zero.

pub fn pad_with_zeros(&mut self) -> Array<u8, BS>

Pad remaining data with zeros and return resulting block.

pub fn get_pos(&self) -> usize

Return current cursor position.

pub fn get_data(&self) -> &[u8]

Return slice of data stored inside the buffer.

pub fn set(&mut self, buf: Array<u8, BS>, pos: usize)

Set buffer content and cursor position.

Panics

If pos is bigger or equal to block size.

pub fn size(&self) -> usize

Return size of the internal buffer in bytes.

pub fn remaining(&self) -> usize

Return number of remaining bytes in the internal buffer.

pub(crate) unsafe fn set_pos_unchecked(&mut self, pos: usize)

Set buffer position.

Safety

Bytes in the range of 0..pos in the buffer field must be properly initialized.

pos must satisfy invariant of buffer kind, i.e. for eager hashes it must be strictly smaller than block size and for lazy hashes it must be smaller or equal to block size.

pub(crate) unsafe fn set_data_unchecked(&mut self, buf: &[u8])

Set buffer data.

Safety

Length of buf must satisfy invariant of buffer kind, i.e. for eager hashes it must be strictly smaller than block size and for lazy hashes it must be smaller or equal to block size.

impl<BS, K: BufferKind> BlockBuffer<BS, K>

where BS: Add<K::Overhead> + BlockSizes, Sum<BS, K::Overhead>: ArraySize,

pub fn serialize(&self) -> SerializedBuffer<BS, K>

Serialize buffer into a byte array.

pub fn deserialize(buf: &SerializedBuffer<BS, K>) -> Result<Self, Error>

Deserialize buffer from a byte array.

Errors

If buf does not represent a valid serialization of BlockBuffer.

impl<BS: BlockSizes> BlockBuffer<BS, Eager>

pub fn digest_pad( &mut self, delim: u8, suffix: &[u8], compress: impl FnMut(&Array<u8, BS>), )

Compress remaining data after padding it with delim, zeros and the suffix bytes. If there is not enough unused space, compress will be called twice.

Panics

If suffix length is bigger than block size.

pub fn len64_padding_be( &mut self, data_len: u64, compress: impl FnMut(&Array<u8, BS>), )

Pad message with 0x80, zeros and 64-bit message length using big-endian byte order.

pub fn len64_padding_le( &mut self, data_len: u64, compress: impl FnMut(&Array<u8, BS>), )

Pad message with 0x80, zeros and 64-bit message length using little-endian byte order.

pub fn len128_padding_be( &mut self, data_len: u128, compress: impl FnMut(&Array<u8, BS>), )

Pad message with 0x80, zeros and 128-bit message length using big-endian byte order.

Trait Implementations

impl<BS: BlockSizes, K: BufferKind> Clone for BlockBuffer<BS, K>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<BS: BlockSizes, K: BufferKind> Debug for BlockBuffer<BS, K>

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

Formats the value using the given formatter.

impl<BS: BlockSizes, K: BufferKind> Default for BlockBuffer<BS, K>

fn default() -> Self

Returns the “default value” for a type.

impl<BS: BlockSizes, K: BufferKind> Drop for BlockBuffer<BS, K>

fn drop(&mut self)

Executes the destructor for this type.