Struct Bitmap

pub struct Bitmap {
    bytes: Vec<u8>,
    n_inputs: u32,
}

A Bitmap used to request proof elements in Utreexo proofs.

This bitmap represents which inputs the sender needs in the proof. Each bit in the bitmap corresponds to an input in the block, where true means the input should be included in the proof.

Fields

bytes: Vec<u8>

The actual bytes representing the bitmap.

n_inputs: u32

How many elements have been pushed into the bitmap.

Implementations

impl Bitmap

pub fn new() -> Self

Creates a new empty Bitmap.

Use the push_input method to add inputs to the bitmap.

pub fn push_input(&mut self, request: bool)

Adds a new input to the bitmap. This method takes a boolean request which indicates whether the input should be requested from our remote peer.

pub fn is_empty(&self) -> bool

Returns whether the bitmap is empty (i.e., has no inputs).

Trait Implementations

impl Clone for Bitmap

fn clone(&self) -> Bitmap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bitmap

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

Formats the value using the given formatter.

impl Default for Bitmap

fn default() -> Bitmap

Returns the “default value” for a type.

impl Encodable for Bitmap

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

Encodes an object with a well-defined format.

impl Hash for Bitmap

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 Bitmap

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

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

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

impl StructuralPartialEq for Bitmap