Struct highway::AvxHash

pub struct AvxHash { /* fields omitted */ }

AVX empowered implementation that will only work on x86_64 with avx2 enabled at the CPU level.

Implementations

impl AvxHash

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

Creates a new AvxHash while circumventing the runtime check for avx2.

Safety

If called on a machine without avx2, 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 avx2 capabilities

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

Creates a new AvxHash if the avx2 feature is detected.

Trait Implementations

impl Clone for AvxHash

pub fn clone(&self) -> AvxHash

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AvxHash

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

Formats the value using the given formatter.

impl Default for AvxHash

pub fn default() -> AvxHash

Returns the "default value" for a type.

impl Hasher for AvxHash

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

Writes some data into this Hasher.

pub fn finish(&self) -> u64

Returns the hash value for the values written so far.

pub fn write_u8(&mut self, i: u8)

Writes a single u8 into this hasher.

pub fn write_u16(&mut self, i: u16)

Writes a single u16 into this hasher.

pub fn write_u32(&mut self, i: u32)

Writes a single u32 into this hasher.

pub fn write_u64(&mut self, i: u64)

Writes a single u64 into this hasher.

pub fn write_u128(&mut self, i: u128)

Writes a single u128 into this hasher.

pub fn write_usize(&mut self, i: usize)

Writes a single usize into this hasher.

pub fn write_i8(&mut self, i: i8)

Writes a single i8 into this hasher.

pub fn write_i16(&mut self, i: i16)

Writes a single i16 into this hasher.

pub fn write_i32(&mut self, i: i32)

Writes a single i32 into this hasher.

pub fn write_i64(&mut self, i: i64)

Writes a single i64 into this hasher.

pub fn write_i128(&mut self, i: i128)

Writes a single i128 into this hasher.

pub fn write_isize(&mut self, i: isize)

Writes a single isize into this hasher.

impl HighwayHash for AvxHash

pub 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.

pub fn finalize64(self) -> u64

Consumes the hasher to return the 64bit hash

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

Consumes the hasher to return the 128bit hash

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

Consumes the hasher to return the 256bit hash

pub 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.

pub 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.

pub 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 AvxHash

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

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

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

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

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

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

pub 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.

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

Attempts to write an entire buffer into this writer.

pub 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.

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

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

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

Creates a "by reference" adaptor for this instance of Write.