Struct SpanBatchBits

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

Available on crate feature protocol only.

Type for span batch bits.

Implementations

impl SpanBatchBits

pub const fn new(inner: Vec<u8>) -> SpanBatchBits

Creates a new span batch bits.

pub fn decode( b: &mut &[u8], bit_length: usize, ) -> Result<SpanBatchBits, SpanBatchError>

Decodes a standard span-batch bitlist from a reader. The bitlist is encoded as big-endian integer, left-padded with zeroes to a multiple of 8 bits. The encoded bitlist cannot be longer than bit_length.

pub fn encode( w: &mut dyn BufMut, bit_length: usize, bits: &SpanBatchBits, ) -> Result<(), SpanBatchError>

Encodes a standard span-batch bitlist. The bitlist is encoded as big-endian integer, left-padded with zeroes to a multiple of 8 bits. The encoded bitlist cannot be longer than bit_length

pub fn get_bit(&self, index: usize) -> Option<u8>

Get a bit from the SpanBatchBits bitlist.

pub fn set_bit(&mut self, index: usize, value: bool)

Sets a bit in the SpanBatchBits bitlist.

pub fn bit_len(&self) -> usize

Calculates the bit length of the SpanBatchBits bitfield.

Trait Implementations

impl AsRef<[u8]> for SpanBatchBits

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

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

impl Clone for SpanBatchBits

fn clone(&self) -> SpanBatchBits

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpanBatchBits

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

Formats the value using the given formatter.

impl Default for SpanBatchBits

fn default() -> SpanBatchBits

Returns the “default value” for a type.

impl PartialEq for SpanBatchBits

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

impl StructuralPartialEq for SpanBatchBits