Struct BitsRef

pub struct BitsRef<'a>(/* private fields */);

Bits stored as a sequence of bytes (most significant bit first).

Implementations

impl<'a> BitsRef<'a>

pub fn from_bytes(bytes: &'a [u8], len: u64) -> Option<Self>

pub fn all_bytes(self) -> &'a [u8]

All of the bytes stored in the byte sequence: not just the ones actually used.

pub fn len(self) -> u64

The number of bits used in the storage.

pub fn bytes(self) -> &'a [u8]

The used bytes of the byte sequence: bear in mind some of the bits in the last byte may be unused.

pub fn get(self, idx_bits: u64) -> Option<bool>

Get the byte at a specific index.

Returns None for out-of-bounds.

pub fn count_ones(self) -> u64

Count the set bits (O(n)).

pub fn count_zeros(self) -> u64

Count the unset bits (O(n)).

pub fn rank_ones(self, idx: u64) -> Option<u64>

Count the set bits before a position in the bits (O(n)).

Returns None it the index is out of bounds.

pub fn rank_zeros(self, idx: u64) -> Option<u64>

Count the unset bits before a position in the bits (O(n)).

Returns None it the index is out of bounds.

pub fn select_ones(self, target_rank: u64) -> Option<u64>

Find the position of a set bit by its rank (O(n)).

Returns None if no suitable bit is found. It is always the case otherwise that rank_ones(result) == Some(target_rank) and get(result) == Some(true).

pub fn select_zeros(self, target_rank: u64) -> Option<u64>

Find the position of an unset bit by its rank (O(n)).

Returns None if no suitable bit is found. It is always the case otherwise that rank_zeros(result) == Some(target_rank) and get(result) == Some(false).

Trait Implementations

impl<'a> Clone for BitsRef<'a>

fn clone(&self) -> BitsRef<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BitsRef<'a>

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

Formats the value using the given formatter.

impl<'a> From<BitsRef<'a>> for (&'a [u8], u64)

fn from(bits: BitsRef<'a>) -> Self

Converts to this type from the input type.

impl<'a> Ord for BitsRef<'a>

fn cmp(&self, other: &Self) -> 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<'a> PartialEq for BitsRef<'a>

fn eq(&self, other: &Self) -> 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<'a> PartialOrd for BitsRef<'a>

fn partial_cmp(&self, other: &Self) -> 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<'a> Copy for BitsRef<'a>

impl<'a> Eq for BitsRef<'a>