Struct TxMerkleNode 

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

A hash of the Merkle tree branch or root for transactions.

Implementations

impl TxMerkleNode

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

Constructs a new type from the underlying byte array.

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

Returns the underlying byte array.

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

Returns a reference to the underlying byte array.

impl TxMerkleNode

pub fn from_leaf(leaf: Txid) -> Self

Convert a Txid hash to a leaf node of the tree.

pub fn combine(&self, other: &Self) -> Self

Combine two nodes to get a single node. The final node of a tree is called the “root”.

pub fn calculate_root<I: Iterator<Item = Txid>>(iter: I) -> Option<Self>

Given an iterator of leaves, compute the Merkle root.

Returns None if the iterator was empty, or if the transaction list contains consecutive duplicates which would trigger CVE 2012-2459. Blocks with duplicate transactions will always be invalid, so there is no harm in us refusing to compute their merkle roots.

Unless you are certain your transaction list is nonempty and has no duplicates, you should not unwrap the Option returned by this method!

Trait Implementations

impl<'a> Arbitrary<'a> for TxMerkleNode

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl AsRef<[u8]> for TxMerkleNode

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

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

impl AsRef<[u8; 32]> for TxMerkleNode

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

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

impl Borrow<[u8]> for TxMerkleNode

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

Immutably borrows from an owned value.

impl Borrow<[u8; 32]> for TxMerkleNode

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

Immutably borrows from an owned value.

impl Clone for TxMerkleNode

fn clone(&self) -> TxMerkleNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TxMerkleNode

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

Formats the value using the given formatter.

impl Decodable for TxMerkleNode

type Decoder = TxMerkleNodeDecoder

Associated decoder for the type.

fn decoder() -> Self::Decoder

Constructs a “default decoder” for the type.

impl<'de> Deserialize<'de> for TxMerkleNode

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

Deserialize this value from the given Serde deserializer.

impl Display for TxMerkleNode

Available on crate feature hex only.

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

Formats the value using the given formatter.

impl Encodable for TxMerkleNode

type Encoder<'e> = TxMerkleNodeEncoder<'e>

The encoder associated with this type. Conceptually, the encoder is like an iterator which yields byte slices.

fn encoder(&self) -> Self::Encoder<'_>

Constructs a “default encoder” for the type.

impl FromStr for TxMerkleNode

Available on crate feature hex only.

type Err = DecodeFixedLengthBytesError

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 TxMerkleNode

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 LowerHex for TxMerkleNode

Available on crate feature hex only.

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

Formats the value using the given formatter.

impl Ord for TxMerkleNode

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

fn eq(&self, other: &TxMerkleNode) -> 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 PartialOrd for TxMerkleNode

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

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

Serialize this value into the given Serde serializer.

impl UpperHex for TxMerkleNode

Available on crate feature hex only.

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

Formats the value using the given formatter.

impl Copy for TxMerkleNode

impl Eq for TxMerkleNode

impl StructuralPartialEq for TxMerkleNode