Struct UtreexoProofMask

pub struct UtreexoProofMask(u8);

The UtreexoProofMask can be used to specify which parts of the proof data to request.

A UtreexoProof is composed of three parts:

• Proof Hashes: the hashes that compose the Merkle proof, used to recompute the Utreexo forest’s roots.
• Leaf Data: the data associated with the UTXOs being spent, such as the [bitcoin::Amount] being spent and the ScriptPubKey.
• Targets: the position indexes in the Utreexo forest for the UTXOs being spent, used to recompute the forest roots.

The UtreexoProofMask’s bits can be set depending on what data you want to request.

Tuple Fields

0: u8

Implementations

impl UtreexoProofMask

const TARGETS: u8 = 1u8

Whether to include the targets in the proof.

const PROOF_HASHES: u8 = 2u8

Whether to include the proof hashes in the proof.

const LEAF_DATA: u8 = 4u8

Whether to include the leaf data in the proof.

const ALL: u8 = 7u8

Request everything

pub fn new() -> Self

Creates a new empty UtreexoProofMask, with no fields selected.

Use the include_* methods to select which fields to include, or UtreexoProofMask::request_all to include all fields.

pub fn request_all() -> Self

Creates a new UtreexoProofMask that requests all fields.

This is a special constructor for the common case where you want to request all fields in the proof. If your goal is to request specific fields, use the UtreexoProofMask::new constructor and the include_* methods to choose what you need.

pub fn request_targets(self) -> Self

Whether to include the targets in the proof.

pub fn request_proof_hashes(self) -> Self

Whether to include the proof hashes in the proof.

pub fn request_leaf_data(self) -> Self

Whether to include the leaf data in the proof.

Trait Implementations

impl Clone for UtreexoProofMask

fn clone(&self) -> UtreexoProofMask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UtreexoProofMask

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

Formats the value using the given formatter.

impl Default for UtreexoProofMask

fn default() -> UtreexoProofMask

Returns the “default value” for a type.

impl Encodable for UtreexoProofMask

fn consensus_encode<W: Write + ?Sized>( &self, writer: &mut W, ) -> Result<usize, Error>

Encodes an object with a well-defined format.

impl Hash for UtreexoProofMask

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 Ord for UtreexoProofMask

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

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

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

impl StructuralPartialEq for UtreexoProofMask