Struct bitcoin_hashes::sha256::Hash

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

Output of the SHA256 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; 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.

impl Hash

pub fn hash_again(&self) -> Hash

Iterate the sha256 algorithm to turn a sha256 hash into a sha256d hash

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

Computes hash from bytes in const context.

Warning: this function is inefficient. It should be only used in const context.

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

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

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<'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 = 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

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

The byte array that represents the hash internally.

const LEN: usize = 32usize

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

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.

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) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<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: &Rhs) -> bool

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

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.

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

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

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

Serialize this value into the given Serde serializer.

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

impl StructuralPartialEq for Hash