Struct SseHash

pub struct SseHash { /* private fields */ }

SSE empowered implementation that will only work on x86_64 with sse 4.1 enabled at the CPU level.

Implementations

impl SseHash

pub unsafe fn force_new(key: Key) -> Self

Available with target feature sse4.1 only.

Creates a new SseHash while circumventing the runtime check for sse4.1.

Safety

If called on a machine without sse4.1, a segfault will occur. Only use if you have control over the deployment environment and have either benchmarked that the runtime check is significant or are unable to check for sse4.1 capabilities

pub fn new(key: Key) -> Option<Self>

Create a new SseHash if the sse4.1 feature is detected

pub unsafe fn force_from_checkpoint(data: [u8; 164]) -> Self

Available with target feature sse4.1 only.

Creates a new SseHash from a checkpoint while circumventing the runtime check for sse4.1.

Safety

See Self::force_new for safety concerns.

pub fn from_checkpoint(data: [u8; 164]) -> Option<Self>

Create a new SseHash from a checkpoint if the sse4.1 feature is detected

Trait Implementations

impl Clone for SseHash

fn clone(&self) -> SseHash

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SseHash

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

Formats the value using the given formatter.

impl Default for SseHash

fn default() -> SseHash

Returns the “default value” for a type.

impl Hasher for SseHash

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

Writes some data into this Hasher.

fn finish(&self) -> u64

Returns the hash value for the values written so far.

fn write_u8(&mut self, i: u8)

Writes a single u8 into this hasher.

fn write_u16(&mut self, i: u16)

Writes a single u16 into this hasher.

fn write_u32(&mut self, i: u32)

Writes a single u32 into this hasher.

fn write_u64(&mut self, i: u64)

Writes a single u64 into this hasher.

fn write_u128(&mut self, i: u128)

Writes a single u128 into this hasher.

fn write_usize(&mut self, i: usize)

Writes a single usize into this hasher.

fn write_i8(&mut self, i: i8)

Writes a single i8 into this hasher.

fn write_i16(&mut self, i: i16)

Writes a single i16 into this hasher.

fn write_i32(&mut self, i: i32)

Writes a single i32 into this hasher.

fn write_i64(&mut self, i: i64)

Writes a single i64 into this hasher.

fn write_i128(&mut self, i: i128)

Writes a single i128 into this hasher.

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.

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

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

Writes a single str into this hasher.

impl HighwayHash for SseHash

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

Adds data to be hashed. If it is important, the performance characteristics of this function differs depending on the amount of data previously hashed and the amount of data to be hashed. For instance, if one appends 50, 1 byte slices then appending the 32nd byte will have a performance outlier as the internal 32 byte block is complete and internally processed.

fn finalize64(self) -> u64

Consumes the hasher to return the 64bit hash

fn finalize128(self) -> [u64; 2]

Consumes the hasher to return the 128bit hash

fn finalize256(self) -> [u64; 4]

Consumes the hasher to return the 256bit hash

fn checkpoint(&self) -> [u8; 164]

Serialize the hasher state to be persisted or resumed by another hasher

fn hash64(self, data: &[u8]) -> u64

Convenience function for hashing all data in a single call and receiving a 64bit hash. Results are equivalent to appending the data manually.

fn hash128(self, data: &[u8]) -> [u64; 2]

Convenience function for hashing all data in a single call and receiving a 128bit hash. Results are equivalent to appending the data manually.

fn hash256(self, data: &[u8]) -> [u64; 4]

Convenience function for hashing all data in a single call and receiving a 256bit hash. Results are equivalent to appending the data manually.

impl Write for SseHash

fn write(&mut self, bytes: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

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

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.