Struct Hash

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

Output of the SHA256t hash function.

Implementations

impl<T: Tag> Hash<T>

pub fn from_bytes_ref(bytes: &[u8; 32]) -> &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; 32]) -> &mut Self

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

Trait Implementations

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

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

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

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

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

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

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

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

Immutably borrows from an owned value.

impl<T: Tag> Clone for Hash<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Tag> Debug for Hash<T>

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

Formats the value using the given formatter.

impl<T: Tag> Default for Hash<T>

fn default() -> Self

Returns the “default value” for a type.

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

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

Deserialize this value from the given Serde deserializer.

impl<T: Tag> Display for Hash<T>

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

Formats the value using the given formatter.

impl<T: Tag> FromStr for Hash<T>

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

fn hash<H: Hasher>(&self, h: &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<T: Tag> Hash for Hash<T>

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() -> Self::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>, 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.

fn hash_byte_chunks<B, I>(byte_slices: I) -> Self

where B: AsRef<[u8]>, I: IntoIterator<Item = B>,

Hashes all the byte slices retrieved from the iterator together.

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

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<T: Tag> LowerHex for Hash<T>

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

Formats the value using the given formatter.

impl<T: Tag> Ord for Hash<T>

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: Tag> PartialEq for Hash<T>

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: Tag> PartialOrd for Hash<T>

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: Tag> SerdeHash for Hash<T>

const N: usize = 32usize

Size, in bits, of the hash.

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

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

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

Do serde serialization.

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

Do serde deserialization.

impl<T: Tag> Serialize for Hash<T>

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

Serialize this value into the given Serde serializer.

impl<T: Tag> UpperHex for Hash<T>

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

Formats the value using the given formatter.

impl<T: Tag> Copy for Hash<T>

impl<T: Tag> Eq for Hash<T>