Struct multiproof_rs::keys::binary_key::BinaryKey

pub struct BinaryKey(_, _, _);

Represents a key whose basic unit is the bit. This is meant to be used at the key in binary trees.

Bits are stored inside an array of bytes, and are read left to right. The structure also contains the start and end offset of the bit field.

Example structure

The following code will create a bit field with 6 bits spread over two integers.

use multiproof_rs::keys::BinaryKey;
let bitkey = BinaryKey::new(vec![0x55; 2], 3, 6);

The internal representation is therefore:

byte #    |     1        2
bit  #    | 76543210 76543210
----------+------------------
bit value | 01010101 01010101
offsets   |     ^     ^
          |   start  end

Methods

impl BinaryKey

pub fn new(data: Vec<u8>, start: usize, end: usize) -> Self

Trait Implementations

impl Clone for BinaryKey

fn clone(&self) -> BinaryKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BinaryKey

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

Formats the value using the given formatter.

impl<'_> From<&'_ [u8]> for BinaryKey

fn from(nibbles: &[u8]) -> Self

Performs the conversion.

impl From<Vec<u8>> for BinaryKey

fn from(bytes: Vec<u8>) -> Self

Performs the conversion.

impl Index<usize> for BinaryKey

type Output = u8

The returned type after indexing.

fn index(&self, i: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Key<u8> for BinaryKey

fn tail(&self) -> Self

Returns a copy of the current key, in which the first unit (i.e. byte, bit, nibble) has been removed. Note that the tail of an empty list is another empty list.

fn len(&self) -> usize

Returns the number of units (i.e. bit, nibble or byte)

fn is_empty(&self) -> bool

Returns true if the key is zero unit long.

impl PartialEq<BinaryKey> for BinaryKey

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for BinaryKey