Trait bdk_chain::bitcoin::hashes::Hash

pub trait Hash: Copy + Clone + PartialEq + Eq + PartialOrd + Ord + Hash + Debug + Display + LowerHex + Index<RangeFull, Output = [u8], Output = [u8], Output = [u8], Output = [u8], Output = u8> + Index<RangeFrom<usize>> + Index<RangeTo<usize>> + Index<Range<usize>> + Index<usize> + Borrow<[u8]> {
    type Engine: HashEngine;
    type Bytes: FromHex + Copy;

    const LEN: usize;
    const DISPLAY_BACKWARD: bool = false;

    // Required methods
    fn from_engine(e: Self::Engine) -> Self;
    fn from_slice(sl: &[u8]) -> Result<Self, FromSliceError>;
    fn to_byte_array(self) -> Self::Bytes;
    fn as_byte_array(&self) -> &Self::Bytes;
    fn from_byte_array(bytes: Self::Bytes) -> Self;
    fn all_zeros() -> Self;

    // Provided methods
    fn engine() -> Self::Engine { ... }
    fn hash(data: &[u8]) -> Self { ... }
    fn hash_byte_chunks<B, I>(byte_slices: I) -> Self
       where B: AsRef<[u8]>,
             I: IntoIterator<Item = B> { ... }
}
Expand description

Trait which applies to hashes of all types.

Required Associated Types§

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: FromHex + Copy

The byte array that represents the hash internally.

Required Associated Constants§

const LEN: usize

Length of the hash, in bytes.

Provided Associated Constants§

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.

Required Methods§

fn from_engine(e: Self::Engine) -> Self

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

fn from_slice(sl: &[u8]) -> Result<Self, 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.

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.

Provided Methods§

fn engine() -> Self::Engine

Constructs a new engine.

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.

Object Safety§

This trait is not object safe.

Implementations on Foreign Types§

§

impl Hash for Hash

§

type Engine = <Hash as Hash>::Engine

§

type Bytes = <Hash as Hash>::Bytes

§

const LEN: usize = 32usize

§

const DISPLAY_BACKWARD: bool = false

§

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

§

fn from_engine(e: <Hash as Hash>::Engine) -> Hash

§

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

§

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

§

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

§

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

§

fn all_zeros() -> Hash

Implementors§

source§

impl Hash for DescriptorId

§

type Engine = <Hash as Hash>::Engine

§

type Bytes = <Hash as Hash>::Bytes

source§

const LEN: usize = 32usize

source§

const DISPLAY_BACKWARD: bool = false

§

impl Hash for BlockHash

§

type Engine = <Hash as Hash>::Engine

§

type Bytes = <Hash as Hash>::Bytes

§

const LEN: usize = 32usize

§

const DISPLAY_BACKWARD: bool = true

§

impl Hash for FilterHash

§

type Engine = <Hash as Hash>::Engine

§

type Bytes = <Hash as Hash>::Bytes

§

const LEN: usize = 32usize

§

const DISPLAY_BACKWARD: bool = true

§

impl Hash for FilterHeader

§

type Engine = <Hash as Hash>::Engine

§

type Bytes = <Hash as Hash>::Bytes

§

const LEN: usize = 32usize

§

const DISPLAY_BACKWARD: bool = true

§

impl Hash for LegacySighash

§

type Engine = <Hash as Hash>::Engine

§

type Bytes = <Hash as Hash>::Bytes

§

const LEN: usize = 32usize

§

const DISPLAY_BACKWARD: bool = false

§

impl Hash for PubkeyHash

§

type Engine = <Hash as Hash>::Engine

§

type Bytes = <Hash as Hash>::Bytes

§

const LEN: usize = 20usize

§

const DISPLAY_BACKWARD: bool = false

§

impl Hash for ScriptHash

§

type Engine = <Hash as Hash>::Engine

§

type Bytes = <Hash as Hash>::Bytes

§

const LEN: usize = 20usize

§

const DISPLAY_BACKWARD: bool = false

§

impl Hash for SegwitV0Sighash

§

type Engine = <Hash as Hash>::Engine

§

type Bytes = <Hash as Hash>::Bytes

§

const LEN: usize = 32usize

§

const DISPLAY_BACKWARD: bool = false

§

impl Hash for TapLeafHash

§

type Engine = <Hash<TapLeafTag> as Hash>::Engine

§

type Bytes = <Hash<TapLeafTag> as Hash>::Bytes

§

const LEN: usize = 32usize

§

const DISPLAY_BACKWARD: bool = false

§

impl Hash for TapNodeHash

§

type Engine = <Hash<TapBranchTag> as Hash>::Engine

§

type Bytes = <Hash<TapBranchTag> as Hash>::Bytes

§

const LEN: usize = 32usize

§

const DISPLAY_BACKWARD: bool = false

§

impl Hash for TapSighash

§

type Engine = <Hash<TapSighashTag> as Hash>::Engine

§

type Bytes = <Hash<TapSighashTag> as Hash>::Bytes

§

const LEN: usize = 32usize

§

const DISPLAY_BACKWARD: bool = false

§

impl Hash for TapTweakHash

§

type Engine = <Hash<TapTweakTag> as Hash>::Engine

§

type Bytes = <Hash<TapTweakTag> as Hash>::Bytes

§

const LEN: usize = 32usize

§

const DISPLAY_BACKWARD: bool = false

§

impl Hash for TxMerkleNode

§

type Engine = <Hash as Hash>::Engine

§

type Bytes = <Hash as Hash>::Bytes

§

const LEN: usize = 32usize

§

const DISPLAY_BACKWARD: bool = true

§

impl Hash for Txid

§

type Engine = <Hash as Hash>::Engine

§

type Bytes = <Hash as Hash>::Bytes

§

const LEN: usize = 32usize

§

const DISPLAY_BACKWARD: bool = true

§

impl Hash for WPubkeyHash

§

type Engine = <Hash as Hash>::Engine

§

type Bytes = <Hash as Hash>::Bytes

§

const LEN: usize = 20usize

§

const DISPLAY_BACKWARD: bool = false

§

impl Hash for WScriptHash

§

type Engine = <Hash as Hash>::Engine

§

type Bytes = <Hash as Hash>::Bytes

§

const LEN: usize = 32usize

§

const DISPLAY_BACKWARD: bool = false

§

impl Hash for WitnessCommitment

§

type Engine = <Hash as Hash>::Engine

§

type Bytes = <Hash as Hash>::Bytes

§

const LEN: usize = 32usize

§

const DISPLAY_BACKWARD: bool = true

§

impl Hash for WitnessMerkleNode

§

type Engine = <Hash as Hash>::Engine

§

type Bytes = <Hash as Hash>::Bytes

§

const LEN: usize = 32usize

§

const DISPLAY_BACKWARD: bool = true

§

impl Hash for Wtxid

§

type Engine = <Hash as Hash>::Engine

§

type Bytes = <Hash as Hash>::Bytes

§

const LEN: usize = 32usize

§

const DISPLAY_BACKWARD: bool = true

§

impl Hash for XKeyIdentifier

§

type Engine = <Hash as Hash>::Engine

§

type Bytes = <Hash as Hash>::Bytes

§

const LEN: usize = 20usize

§

const DISPLAY_BACKWARD: bool = false

§

impl Hash for bdk_chain::bitcoin::hashes::hash160::Hash

§

type Engine = HashEngine

§

type Bytes = [u8; 20]

§

const LEN: usize = 20usize

§

const DISPLAY_BACKWARD: bool = false

§

impl Hash for bdk_chain::bitcoin::hashes::ripemd160::Hash

§

type Engine = HashEngine

§

type Bytes = [u8; 20]

§

const LEN: usize = 20usize

§

const DISPLAY_BACKWARD: bool = false

§

impl Hash for bdk_chain::bitcoin::hashes::sha1::Hash

§

type Engine = HashEngine

§

type Bytes = [u8; 20]

§

const LEN: usize = 20usize

§

const DISPLAY_BACKWARD: bool = false

§

impl Hash for bdk_chain::bitcoin::hashes::sha256::Hash

§

type Engine = HashEngine

§

type Bytes = [u8; 32]

§

const LEN: usize = 32usize

§

const DISPLAY_BACKWARD: bool = false

§

impl Hash for bdk_chain::bitcoin::hashes::sha256d::Hash

§

type Engine = HashEngine

§

type Bytes = [u8; 32]

§

const LEN: usize = 32usize

§

const DISPLAY_BACKWARD: bool = true

§

impl Hash for bdk_chain::bitcoin::hashes::sha384::Hash

§

type Engine = HashEngine

§

type Bytes = [u8; 48]

§

const LEN: usize = 48usize

§

const DISPLAY_BACKWARD: bool = false

§

impl Hash for bdk_chain::bitcoin::hashes::sha512::Hash

§

type Engine = HashEngine

§

type Bytes = [u8; 64]

§

const LEN: usize = 64usize

§

const DISPLAY_BACKWARD: bool = false

§

impl Hash for bdk_chain::bitcoin::hashes::sha512_256::Hash

§

type Engine = HashEngine

§

type Bytes = [u8; 32]

§

const LEN: usize = 32usize

§

const DISPLAY_BACKWARD: bool = false

§

impl Hash for bdk_chain::bitcoin::hashes::siphash24::Hash

§

type Engine = HashEngine

§

type Bytes = [u8; 8]

§

const LEN: usize = 8usize

§

const DISPLAY_BACKWARD: bool = false

§

impl<T> Hash for Hmac<T>
where T: Hash,

§

type Engine = HmacEngine<T>

§

type Bytes = <T as Hash>::Bytes

§

const LEN: usize = T::LEN

§

impl<T> Hash for bdk_chain::bitcoin::hashes::sha256t::Hash<T>
where T: Tag,

§

type Engine = HashEngine

§

type Bytes = [u8; 32]

§

const LEN: usize = 32usize

§

const DISPLAY_BACKWARD: bool = true