Struct Hash

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

Output of the SHA256t hash function.

Implementations

impl<T: Tag> Hash<T>

pub const LEN: usize = 32usize

Length of the hash, in bytes.

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

Creates a default hash engine, adds bytes to it, then finalizes the engine.

Returns

The digest created by hashing bytes with engine’s hashing algorithm.

pub fn engine() -> Engine<T>

Returns a hash engine that is ready to be used for data.

pub fn from_engine(engine: Engine<T>) -> Self

Creates a Hash from an engine.

This is equivalent to calling Hash::from_byte_array(engine.finalize()).

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.

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

Copies a byte slice into a hash object.

pub fn from_byte_array(bytes: [u8; 32]) -> Self

Constructs a hash from the underlying byte array.

pub fn to_byte_array(self) -> [u8; 32]

Returns the underlying byte array.

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

Returns a reference to the underlying byte array.

pub fn as_bytes(&self) -> &[u8]

Returns a reference to the underlying byte array as a slice.

pub fn to_bytes(&self) -> Vec<u8>

Available on crate feature alloc only.

Copies the underlying bytes into a new Vec.

pub fn all_zeros() -> Self

Returns an all zero hash.

An all zeros hash is a made up construct because there is not a known input that can create it, however it is used in various places in Bitcoin e.g., the Bitcoin genesis block’s previous blockhash and the coinbase transaction’s outpoint txid.

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

Available on crate feature schemars only.

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

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

Available on crate feature serde only.

Size, in bits, of the hash.

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

Available on crate feature serde only.

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

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

Available on crate feature serde only.

Do serde serialization.

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

Available on crate feature serde only.

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>