Struct bitcoin_hashes::siphash24::Hash

pub struct Hash(/* private fields */);

Output of the SipHash24 hash function.

Implementations

impl Hash

pub fn forward_hex(&self) -> impl '_ + LowerHex + UpperHex

Displays hex forwards, regardless of how this type would display it naturally.

This is mainly intended as an internal method and you shouldn’t need it unless you’re doing something special.

pub fn backward_hex(&self) -> impl '_ + LowerHex + UpperHex

Displays hex backwards, regardless of how this type would display it naturally.

This is mainly intended as an internal method and you shouldn’t need it unless you’re doing something special.

pub fn from_bytes_ref(bytes: &[u8; 8]) -> &Self

Zero cost conversion between a fixed length byte array shared reference and a shared reference to this Hash type.

pub fn from_bytes_mut(bytes: &mut [u8; 8]) -> &mut Self

Zero cost conversion between a fixed length byte array exclusive reference and an exclusive reference to this Hash type.

impl Hash

pub fn hash_with_keys(k0: u64, k1: u64, data: &[u8]) -> Hash

Hashes the given data with an engine with the provided keys.

pub fn hash_to_u64_with_keys(k0: u64, k1: u64, data: &[u8]) -> u64

Hashes the given data directly to u64 with an engine with the provided keys.

pub fn from_engine_to_u64(e: HashEngine) -> u64

Produces a hash as u64 from the current state of a given engine.

pub fn as_u64(&self) -> u64

Returns the (little endian) 64-bit integer representation of the hash value.

pub fn from_u64(hash: u64) -> Hash

Creates a hash from its (little endian) 64-bit integer representation.

Trait Implementations

impl AsRef<[u8]> for Hash

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<[u8; 8]> for Hash

fn as_ref(&self) -> &[u8; 8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<[u8]> for Hash

fn borrow(&self) -> &[u8]

Immutably borrows from an owned value.

impl Clone for Hash

fn clone(&self) -> Hash

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hash

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

Formats the value using the given formatter.

impl Display for Hash

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

Formats the value using the given formatter.

impl FromStr for Hash

type Err = HexToArrayError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Hash

type Engine = HashEngine

A hashing engine which bytes can be serialized into. It is expected to implement the io::Write trait, and to never return errors under any conditions.

type Bytes = [u8; 8]

The byte array that represents the hash internally.

const LEN: usize = 8usize

Length of the hash, in bytes.

const DISPLAY_BACKWARD: bool = false

Flag indicating whether user-visible serializations of this hash should be backward. For some reason Satoshi decided this should be true for Sha256dHash, so here we are.

fn engine() -> Self::Engine

Constructs a new engine.

fn from_engine(e: HashEngine) -> Hash

Produces a hash from the current state of a given engine.

fn from_slice(sl: &[u8]) -> Result<Hash, FromSliceError>

Copies a byte slice into a hash object.

fn to_byte_array(self) -> Self::Bytes

Returns the underlying byte array.

fn as_byte_array(&self) -> &Self::Bytes

Returns a reference to the underlying byte array.

fn from_byte_array(bytes: Self::Bytes) -> Self

Constructs a hash from the underlying byte array.

fn all_zeros() -> Self

Returns an all zero hash.

fn hash(data: &[u8]) -> Self

Hashes some bytes.

impl Hash for Hash

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<I: SliceIndex<[u8]>> Index<I> for Hash

type Output = <I as SliceIndex<[u8]>>::Output

The returned type after indexing.

fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl LowerHex for Hash

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

Formats the value using the given formatter.

impl Ord for Hash

fn cmp(&self, other: &Hash) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Hash

fn eq(&self, other: &Hash) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Hash

fn partial_cmp(&self, other: &Hash) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl UpperHex for Hash

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

Formats the value using the given formatter.

impl Copy for Hash

impl Eq for Hash

impl StructuralPartialEq for Hash