Struct Hash

pub struct Hash<T>(/* private fields */)
where
    T: Tag;

Output of the SHA256t hash function.

Implementations

impl<T> Hash<T>

where T: Tag,

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.

Trait Implementations

impl<T> AsRef<[u8]> for Hash<T>

where T: Tag,

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

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

impl<T> AsRef<[u8; 32]> for Hash<T>

where T: Tag,

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

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

impl<T> Borrow<[u8]> for Hash<T>

where T: Tag,

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

Immutably borrows from an owned value.

impl<T> Clone for Hash<T>

where T: Tag,

fn clone(&self) -> Hash<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Hash<T>

where T: Tag,

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

Formats the value using the given formatter.

impl<T> Default for Hash<T>

where T: Tag,

fn default() -> Hash<T>

Returns the “default value” for a type.

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

where T: Tag,

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for Hash<T>

where T: Tag,

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

Formats the value using the given formatter.

impl From<Hash<TapBranchTag>> for TapNodeHash

fn from(inner: Hash<TapBranchTag>) -> TapNodeHash

Converts to this type from the input type.

impl From<Hash<TapLeafTag>> for TapLeafHash

fn from(inner: Hash<TapLeafTag>) -> TapLeafHash

Converts to this type from the input type.

impl From<Hash<TapSighashTag>> for TapSighash

fn from(inner: Hash<TapSighashTag>) -> TapSighash

Converts to this type from the input type.

impl From<Hash<TapTweakTag>> for TapTweakHash

fn from(inner: Hash<TapTweakTag>) -> TapTweakHash

Converts to this type from the input type.

impl From<TapLeafHash> for Hash<TapLeafTag>

fn from(hashtype: TapLeafHash) -> Hash<TapLeafTag>

Converts to this type from the input type.

impl From<TapNodeHash> for Hash<TapBranchTag>

fn from(hashtype: TapNodeHash) -> Hash<TapBranchTag>

Converts to this type from the input type.

impl From<TapSighash> for Hash<TapSighashTag>

fn from(hashtype: TapSighash) -> Hash<TapSighashTag>

Converts to this type from the input type.

impl From<TapTweakHash> for Hash<TapTweakTag>

fn from(hashtype: TapTweakHash) -> Hash<TapTweakTag>

Converts to this type from the input type.

impl<T> FromStr for Hash<T>

where T: Tag,

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Hash<T>, <Hash<T> as FromStr>::Err>

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

impl<T> Hash for Hash<T>

where T: Tag,

fn hash<H>(&self, h: &mut H)

where H: Hasher,

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<T> Hash for Hash<T>

where T: Tag,

const LEN: usize = 32usize

Length of the hash, in bytes.

const DISPLAY_BACKWARD: bool = true

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.

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; 32]

The byte array that represents the hash internally.

fn engine() -> <Hash<T> as Hash>::Engine

Constructs a new engine.

fn from_engine(e: HashEngine) -> Hash<T>

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

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

Copies a byte slice into a hash object.

fn to_byte_array(self) -> <Hash<T> as Hash>::Bytes

Returns the underlying byte array.

fn as_byte_array(&self) -> &<Hash<T> as Hash>::Bytes

Returns a reference to the underlying byte array.

fn from_byte_array(bytes: <Hash<T> as Hash>::Bytes) -> Hash<T>

Constructs a hash from the underlying byte array.

fn all_zeros() -> Hash<T>

Returns an all zero hash.

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

Hashes some bytes.

impl<I, T> Index<I> for Hash<T>

where I: SliceIndex<[u8]>, T: Tag,

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

The returned type after indexing.

fn index(&self, index: I) -> &<Hash<T> as Index<I>>::Output

Performs the indexing (container[index]) operation.

impl<T> LowerHex for Hash<T>

where T: Tag,

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

Formats the value using the given formatter.

impl<T> Ord for Hash<T>

where T: Tag,

fn cmp(&self, other: &Hash<T>) -> 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,

Restrict a value to a certain interval.

impl<T> PartialEq for Hash<T>

where T: Tag,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> PartialOrd for Hash<T>

where T: Tag,

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T> SerdeHash for Hash<T>

where T: Tag,

const N: usize = 32usize

Size, in bits, of the hash.

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

Helper function to turn a deserialized slice into the correct hash type.

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

where S: Serializer,

Do serde serialization.

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

where D: Deserializer<'de>,

Do serde deserialization.

impl<T> Serialize for Hash<T>

where T: Tag,

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> ThirtyTwoByteHash for Hash<T>

where T: Tag,

fn into_32(self) -> [u8; 32]

Converts the object into a 32-byte array

impl<T> UpperHex for Hash<T>

where T: Tag,

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

Formats the value using the given formatter.

impl<T> Copy for Hash<T>

where T: Tag,

impl<T> Eq for Hash<T>

where T: Tag,