Struct xxhrs::XXH3_128

pub struct XXH3_128<'a> { /* fields omitted */ }

xxh3 64 bit c library bindings

Streaming mode is used just like the Hasher trait, but does not implement the trait because this returns u128, hasher requires u64

::default() and ::new() are equivalent; they construct the unseeded streaming variant…

Implementations

impl<'_> XXH3_128<'_>

pub fn hash(bytes: &[u8]) -> u128

One-shot hashing

pub unsafe fn hash_with_entropy_buffer(entropy: &[u8], bytes: &[u8]) -> u128

One-shot hashing with custom entropy buffer.

This corresponds to XXH3_64bits_withSecret. You probably want to use hash_with_entropy instead unless you really need to supply custom size entropy buffers, in which case this is the function to use.

Safety

This function is marked unsafe just to encourage using the EntropyPool abstraction which makes it hard to produce particularly unsafe entropy pools.

The entropy pool must be at least 136 bytes.

pub fn hash_with_entropy(entropy: &EntropyPool, bytes: &[u8]) -> u128

One-shot hashing with custom entropy buffer.

This corresponds to XXH3_64bits_withSecret.

pub fn hash_with_seed(seed: u64, bytes: &[u8]) -> u128

One-shot hashing with seed

pub fn new() -> XXH3_128<'static>

Streaming hashing

pub unsafe fn with_entropy_buffer(entropy: &[u8]) -> XXH3_128<'_>

Streaming hashing with custom entropy buffer.

This corresponds to XXH3_64bits_reset_withSecret.

This function is marked unsafe to discourage it's use; use with_entropy instead which copies the entropy (thus causing far fewer lifetime problems) and uses the safer EntropyPool abstraction.

Safety

Use this function if you really want to avoid the entropy copy or if you really need to use a custom size entropy pool.

The entropy pool must be at least 136 bytes.

pub fn with_entropy(entropy: &EntropyPool) -> XXH3_128<'static>

Streaming hashing with custom entropy buffer.

This corresponds to XXH3_64bits_reset_withSecret.

pub fn with_seed(seed: u64) -> XXH3_128<'static>

Streaming hashing with custom seed.

pub fn write(&mut self, bytes: &[u8])

pub fn finish(&self) -> u128

Trait Implementations

impl<'a> Clone for XXH3_128<'a>

fn clone(&self) -> XXH3_128<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'_> Default for XXH3_128<'_>

fn default() -> Self

Returns the "default value" for a type.