Struct bitcoin::util::taproot::TapBranchHash

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

Taproot-tagged hash for tapscript Merkle tree branches

Implementations

impl TapBranchHash

pub fn from_hash(inner: Hash<TapBranchTag>) -> TapBranchHash

Create this type from the inner hash type.

pub fn as_hash(&self) -> Hash<TapBranchTag>

Convert this type into the inner hash type.

Trait Implementations

impl AsRef<[u8]> for TapBranchHash

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

Performs the conversion.

impl Borrow<[u8]> for TapBranchHash

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

Immutably borrows from an owned value.

impl Clone for TapBranchHash

fn clone(&self) -> TapBranchHash

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TapBranchHash

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

Formats the value using the given formatter.

impl Default for TapBranchHash

fn default() -> TapBranchHash

Returns the “default value” for a type.

impl Deref for TapBranchHash

type Target = [u8]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for TapBranchHash

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

Deserialize this value from the given Serde deserializer.

impl Display for TapBranchHash

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

Formats the value using the given formatter.

impl From<Hash<TapBranchTag>> for TapBranchHash

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

Performs the conversion.

impl From<TapBranchHash> for Hash<TapBranchTag>

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

Performs the conversion.

impl FromStr for TapBranchHash

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<TapBranchHash, Self::Err>

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

impl Hash for TapBranchHash

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Hash for TapBranchHash

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

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 Inner = <Hash<TapBranchTag> as Hash>::Inner

The byte array that represents the hash internally

const LEN: usize

Length of the hash, in bytes

const DISPLAY_BACKWARD: bool

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

Construct a new engine

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

Produce a hash from the current state of a given engine

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

Copies a byte slice into a hash object

fn from_inner(inner: Self::Inner) -> Self

Constructs a hash from the underlying byte array

fn into_inner(self) -> Self::Inner

Unwraps the hash and returns the underlying byte array

fn as_inner(&self) -> &Self::Inner

Unwraps the hash and returns a reference to the underlying byte array

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

Hashes some bytes

impl Index<Range<usize>> for TapBranchHash

type Output = [u8]

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for TapBranchHash

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeFrom<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for TapBranchHash

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeFull) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for TapBranchHash

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeTo<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<usize> for TapBranchHash

type Output = u8

The returned type after indexing.

fn index(&self, index: usize) -> &u8

Performs the indexing (container[index]) operation.

impl LowerHex for TapBranchHash

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

Formats the value using the given formatter.

impl Ord for TapBranchHash

fn cmp(&self, other: &TapBranchHash) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<TapBranchHash> for TapBranchHash

fn eq(&self, other: &TapBranchHash) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<TapBranchHash> for TapBranchHash

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

pub 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 TapBranchHash

const N: usize

Size, in bits, of the hash

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

helper function to turn a deserialized slice into the correct hash type

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

serde serialization

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

serde deserialization

impl Serialize for TapBranchHash

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

Serialize this value into the given Serde serializer.

impl Copy for TapBranchHash

impl Eq for TapBranchHash

impl StructuralEq for TapBranchHash

impl StructuralPartialEq for TapBranchHash