Struct MerkleNode

#[repr(C)]
pub struct MerkleNode(Base);

The MerkleNode is represented as a base field element.

Tuple Fields

0: Base

Implementations

impl MerkleNode

pub fn new(v: Base) -> Self

pub fn inner(&self) -> Base

Reference the raw inner base field element

pub fn from_bytes(bytes: [u8; 32]) -> Option<Self>

Try to create a MerkleNode type from the given 32 bytes. Returns Some if the bytes fit in the base field, and None if not.

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

Convert the MerkleNode type into 32 raw bytes

Trait Implementations

impl AsyncDecodable for MerkleNode

fn decode_async<'life0, 'async_trait, D>( d: &'life0 mut D, ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>

where D: 'async_trait + AsyncRead + Unpin + Send, Self: 'async_trait, 'life0: 'async_trait,

impl AsyncEncodable for MerkleNode

fn encode_async<'life0, 'life1, 'async_trait, S>( &'life0 self, s: &'life1 mut S, ) -> Pin<Box<dyn Future<Output = Result<usize>> + Send + 'async_trait>>

where S: 'async_trait + AsyncWrite + Unpin + Send, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Asynchronously encode an object with a well-defined format. Should only ever error if the underlying AsyncWrite errors. Returns the number of bytes written on success.

impl Clone for MerkleNode

fn clone(&self) -> MerkleNode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConditionallySelectable for MerkleNode

fn conditional_select(a: &Self, b: &Self, choice: Choice) -> Self

Select a or b according to choice.

fn conditional_assign(&mut self, other: &Self, choice: Choice)

Conditionally assign other to self, according to choice.

fn conditional_swap(a: &mut Self, b: &mut Self, choice: Choice)

Conditionally swap self and other if choice == 1; otherwise, reassign both unto themselves.

impl Debug for MerkleNode

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

Formats the value using the given formatter.

impl Decodable for MerkleNode

fn decode<D: Read>(d: &mut D) -> Result<Self, Error>

impl Display for MerkleNode

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

Formats the value using the given formatter.

impl Encodable for MerkleNode

fn encode<S: Write>(&self, s: &mut S) -> Result<usize, Error>

Encode an object with a well-defined format. Should only ever error if the underlying Write errors. Returns the number of bytes written on success.

impl From<Fp> for MerkleNode

fn from(x: Base) -> Self

Converts to this type from the input type.

impl FromStr for MerkleNode

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

Tries to decode a base58 string into a MerkleNode type. This string is the same string received by calling MerkleNode::to_string().

type Err = Error

The associated error which can be returned from parsing.

impl Hashable for MerkleNode

fn combine(altitude: Level, left: &Self, right: &Self) -> Self

Implements MerkleCRH^Orchard as defined in https://zips.z.cash/protocol/protocol.pdf#orchardmerklecrh

The layer with 2^n nodes is called “layer n”: - leaves are at layer MERKLE_DEPTH_ORCHARD = 32; - the root is at layer 0. l is MERKLE_DEPTH_ORCHARD - layer - 1. - when hashing two leaves, we produce a node on the layer above the leaves, i.e. layer = 31, l = 0 - when hashing to the final root, we produce the anchor with layer = 0, l = 31.

fn empty_leaf() -> Self

fn empty_root(altitude: Level) -> Self

Produces an empty root at the specified level of the tree by combining empty leaf values.

impl Ord for MerkleNode

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

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

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

impl Eq for MerkleNode

impl StructuralPartialEq for MerkleNode