Struct Xxh3_64 

pub struct Xxh3_64 { /* private fields */ }

XXH3 64-bit hash.

A fast non-cryptographic hash using the XXH3 algorithm. Supports an optional u64 seed and an optional custom 192-byte secret.

Incremental hashing (update) produces exactly the same value as one-shot hashing (checksum, or the xxh3_64 free function), for any input length and any split of the input across update calls. No input can make it panic.

When the std feature is enabled (the default), the long-input path uses AVX2 / AVX-512 (x86) or NEON (aarch64) kernels selected at runtime; with no_std, the kernels are selected at compile time from the enabled target features.

Security

XXH3 is not a cryptographic hash: it must not be used to authenticate messages, derive keys, or store passwords, and a seed or a custom secret is not a security boundary. It is also not collision-resistant against deliberate attacks; do not use it to defend a hash table against attacker-chosen keys (hash flooding).

Example

use xxhash::{Xxh3_64, Checksum};

let hash = Xxh3_64::checksum(b"hello world");

Implementations

impl Xxh3_64

pub const fn with_seed(seed: u64) -> Self

Create a new XXH3-64 hasher with the given seed.

A zero seed is equivalent to the default, unseeded hasher.

pub const fn with_secret(secret: [u8; 192]) -> Self

Create a new XXH3-64 hasher with a custom 192-byte secret (seed = 0).

pub const fn with_seed_and_secret(seed: u64, secret: [u8; 192]) -> Self

Create a new XXH3-64 hasher with a custom seed and secret.

This matches the reference XXH3_64bits_withSecretandSeed() contract: the seed is used for inputs of up to 240 bytes (with the default secret), while the custom secret is used — and the seed is ignored — for longer inputs.

Trait Implementations

impl Checksum for Xxh3_64

type Output = u64

The type of the resulting checksum value.

fn new() -> Self

Create a new checksum instance with default settings (seed = 0, default secret for XXH3 variants).

fn checksum(data: &[u8]) -> u64

Compute the checksum of data in a single call.

fn update(&mut self, data: &[u8])

Feed additional data into the checksum.

fn sum(self) -> u64

Finalize and return the computed checksum value.

impl Clone for Xxh3_64

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Xxh3_64

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

Formats the value using the given formatter.

impl Default for Xxh3_64

fn default() -> Self

Returns the “default value” for a type.