Struct GxHasher

pub struct GxHasher { /* private fields */ }

Expand description

A Hasher for hashing an arbitrary stream of bytes.

§Features

The fastest Hasher of its class¹, for all input sizes
Highly collision resitant
DOS resistance thanks to seed randomization when using GxHasher::default()

¹There might me faster alternatives, such as fxhash for very small input sizes, but that usually have low quality properties.

Implementations§

impl GxHasher

pub fn with_seed(seed: i64) -> GxHasher

Creates a new hasher using the provided seed.

§Warning ⚠️

Hardcoding a seed may make your Hasher vulnerable to DOS attacks. It is recommended to use GxBuildHasher::default() for improved DOS resistance.

§Example

use std::hash::Hasher;
use gxhash::GxHasher;

let mut hasher = GxHasher::with_seed(1234);

hasher.write(b"Hello");
hasher.write_u32(123);
hasher.write_u8(42);

println!("Hash is {:x}!", hasher.finish());

pub fn finish_u128(&self) -> u128

Finish this hasher and return the hashed value as a 128 bit unsigned integer.

Trait Implementations§

impl Clone for GxHasher

fn clone(&self) -> GxHasher

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for GxHasher

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

Formats the value using the given formatter. Read more

impl Default for GxHasher

fn default() -> GxHasher

Creates a new hasher with a empty seed.

§Warning ⚠️

Not using a seed may make your Hasher vulnerable to DOS attacks. It is recommended to use GxBuildHasher::default() for improved DOS resistance.

§Example

use std::hash::Hasher;
use gxhash::GxHasher;

let mut hasher = GxHasher::default();

hasher.write(b"Hello");
hasher.write_u32(123);
hasher.write_u8(42);

println!("Hash is {:x}!", hasher.finish());

impl Hasher for GxHasher

fn finish(&self) -> u64

Returns the hash value for the values written so far. Read more

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

Writes some data into this Hasher. Read more

fn write_u8(&mut self, value: u8)

Writes a single u8 into this hasher.

fn write_u16(&mut self, value: u16)

Writes a single u16 into this hasher.

fn write_u32(&mut self, value: u32)

Writes a single u32 into this hasher.

fn write_u64(&mut self, value: u64)

Writes a single u64 into this hasher.

fn write_u128(&mut self, value: u128)

Writes a single u128 into this hasher.

fn write_i8(&mut self, value: i8)

Writes a single i8 into this hasher.

fn write_i16(&mut self, value: i16)

Writes a single i16 into this hasher.

fn write_i32(&mut self, value: i32)

Writes a single i32 into this hasher.

fn write_i64(&mut self, value: i64)

Writes a single i64 into this hasher.

fn write_i128(&mut self, value: i128)

Writes a single i128 into this hasher.

1.3.0 · Source§

fn write_usize(&mut self, i: usize)

Writes a single usize into this hasher.

1.3.0 · Source§

fn write_isize(&mut self, i: isize)

Writes a single isize into this hasher.

fn write_length_prefix(&mut self, len: usize)

🔬This is a nightly-only experimental API. (hasher_prefixfree_extras)

Writes a length prefix into this hasher, as part of being prefix-free. Read more

fn write_str(&mut self, s: &str)

🔬This is a nightly-only experimental API. (hasher_prefixfree_extras)

Writes a single str into this hasher. Read more

Auto Trait Implementations§

impl Freeze for GxHasher

impl RefUnwindSafe for GxHasher

impl Send for GxHasher

impl Sync for GxHasher

impl Unpin for GxHasher

impl UnwindSafe for GxHasher

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.