Struct WitnessCommitment 

pub struct WitnessCommitment(/* private fields */);

A hash corresponding to the witness structure commitment in the coinbase transaction.

Implementations

impl WitnessCommitment

pub fn from_raw_hash(inner: Hash) -> WitnessCommitment

Creates this wrapper type from the inner hash type.

pub fn to_raw_hash(self) -> Hash

Returns the inner hash (sha256, sh256d etc.).

pub fn as_raw_hash(&self) -> &Hash

Returns a reference to the inner hash (sha256, sh256d etc.).

Trait Implementations

impl AsRef<[u8; 32]> for WitnessCommitment

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

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

impl AsRef<[u8]> for WitnessCommitment

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

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

impl Borrow<[u8]> for WitnessCommitment

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

Immutably borrows from an owned value.

impl Clone for WitnessCommitment

fn clone(&self) -> WitnessCommitment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for WitnessCommitment

impl Debug for WitnessCommitment

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

Formats the value using the given formatter.

impl Display for WitnessCommitment

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

Formats the value using the given formatter.

impl Eq for WitnessCommitment

impl From<Hash> for WitnessCommitment

fn from(inner: Hash) -> WitnessCommitment

Converts to this type from the input type.

impl FromStr for WitnessCommitment

type Err = HexToArrayError

The associated error which can be returned from parsing.

fn from_str( s: &str, ) -> Result<WitnessCommitment, <WitnessCommitment as FromStr>::Err>

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

impl Hash for WitnessCommitment

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

where __H: Hasher,

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 WitnessCommitment

const LEN: usize = <sha256d::Hash as ::bitcoin_hashes::Hash>::LEN

Length of the hash, in bytes.

const DISPLAY_BACKWARD: bool = <sha256d::Hash as ::bitcoin_hashes::Hash>::DISPLAY_BACKWARD

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

The byte array that represents the hash internally.

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

Constructs a new engine.

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

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

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

Copies a byte slice into a hash object.

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

Constructs a hash from the underlying byte array.

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

Returns the underlying byte array.

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

Returns a reference to the underlying byte array.

fn all_zeros() -> WitnessCommitment

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> Index<I> for WitnessCommitment

where I: SliceIndex<[u8]>,

type Output = <I as SliceIndex<[u8]>>::Output

The returned type after indexing.

fn index(&self, index: I) -> &<WitnessCommitment as Index<I>>::Output

Performs the indexing (container[index]) operation.

impl LowerHex for WitnessCommitment

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

Formats the value using the given formatter.

impl Ord for WitnessCommitment

fn cmp(&self, other: &WitnessCommitment) -> 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 PartialEq for WitnessCommitment

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for WitnessCommitment

fn partial_cmp(&self, other: &WitnessCommitment) -> 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 StructuralPartialEq for WitnessCommitment

impl UpperHex for WitnessCommitment

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

Formats the value using the given formatter.