Struct SecretBuffer

pub struct SecretBuffer<S> { /* private fields */ }

Available on crate feature xxhash3_64 only.

Holds secret and temporary buffers that are ensured to be appropriately sized.

Implementations

impl SecretBuffer<Box<[u8]>>

pub fn allocate_default() -> Self

Available on crate feature alloc only.

Allocates the secret and temporary buffers and fills them with the default seed and secret values.

pub fn allocate_with_seed(seed: u64) -> Self

Available on crate feature alloc only.

Allocates the secret and temporary buffers and uses the provided seed to construct the secret value.

pub fn allocate_with_seed_and_secret( seed: u64, secret: impl Into<Box<[u8]>>, ) -> Result<Self, SecretTooShortError<Box<[u8]>>>

Available on crate feature alloc only.

Allocates the temporary buffer and uses the provided seed and secret buffer.

impl<S> SecretBuffer<S>

where S: FixedBuffer,

pub fn new(seed: u64, secret: S) -> Result<Self, SecretTooShortError<S>>

Takes the seed, secret, and buffer and performs no modifications to them, only validating that the sizes are appropriate.

impl<S> SecretBuffer<S>

pub fn into_secret(self) -> S

Returns the secret.

impl SecretBuffer<&'static [u8; 192]>

pub const fn default() -> Self

Use the default seed and secret values while allocating nothing.

impl<S> SecretBuffer<S>

where S: FixedMutBuffer,

pub fn with_seed(seed: u64, secret: S) -> Result<Self, SecretWithSeedError<S>>

Fills the secret buffer with a secret derived from the seed and the default secret. The secret must be exactly DEFAULT_SECRET_LENGTH bytes long.

Trait Implementations

impl<S: Clone> Clone for SecretBuffer<S>

fn clone(&self) -> SecretBuffer<S>

Returns a copy of the value.

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

Performs copy-assignment from source.