Struct bitcoin_hashes::siphash24::Hash

#[repr(transparent)]
pub struct Hash(_);

Output of the SipHash24 hash function.

Implementations

impl Hash

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

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

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

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

pub fn from_engine_to_u64(e: HashEngine) -> u64

Produce 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

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

Trait Implementations

impl AsRef<[u8]> for Hash

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

Performs the conversion.

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.

pub 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 Default for Hash

fn default() -> Hash

Returns the “default value” for a type.

impl Deref for Hash

type Target = [u8]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for Hash

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Hash, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Hash

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

Formats the value using the given formatter.

impl FromStr for Hash

type Err = Error

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 Inner = [u8; 8]

The byte array that represents the hash internally

fn from_engine(e: HashEngine) -> Hash

Produce a hash from the current state of a given engine

const LEN: usize

Length of the hash, in bytes

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

Copies a byte slice into a hash object

fn into_inner(self) -> Self::Inner

Unwraps the hash and returns the underlying byte array

fn as_inner(&self) -> &Self::Inner

Unwraps the hash and returns a reference to the underlying byte array

fn from_inner(inner: Self::Inner) -> Self

Constructs a hash from the underlying byte array

fn engine() -> Self::Engine

Construct a new engine

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

Hashes some bytes

const DISPLAY_BACKWARD: bool

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.

impl Hash for Hash

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Index<Range<usize>> for Hash

type Output = [u8]

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for Hash

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeFrom<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for Hash

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeFull) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for Hash

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeTo<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<usize> for Hash

type Output = u8

The returned type after indexing.

fn index(&self, index: usize) -> &u8

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.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<Hash> 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: &Hash) -> bool

This method tests for !=.

impl PartialOrd<Hash> for Hash

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

pub 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 SerdeHash for Hash

const N: usize

Size, in bits, of the hash

fn from_slice_delegated(sl: &[u8]) -> Result<Self, Error>

helper function to turn a deserialized slice into the correct hash type

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

serde serialization

fn deserialize<'de, D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

serde deserialization

impl Serialize for Hash

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Copy for Hash

impl Eq for Hash

impl StructuralEq for Hash

impl StructuralPartialEq for Hash