Struct BitString 

pub struct BitString { /* private fields */ }

Implementations

impl BitString

pub fn bit_len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn get(&self, index: usize) -> Option<bool>

impl BitString

pub fn any(&self) -> bool

pub fn all(&self) -> bool

pub fn is_all_zeros(&self) -> bool

pub fn is_all_ones(&self) -> bool

impl BitString

pub fn as_words(&self) -> &[u64]

Returns the internal little-endian words.

Bit index i is stored in word i / 64, bit offset i % 64. Unused high bits in the last word are guaranteed to be zero.

pub fn first(&self) -> Option<bool>

pub fn get_chunk(&self, bit_start: usize) -> u64

Reads up to 64 bits starting at bit_start, returning them in the low bits of a u64.

Bits beyond self.len() are treated as zero.

pub fn last(&self) -> Option<bool>

pub fn to_bool_vec(&self) -> Vec<bool>

impl BitString

pub fn and(&self, rhs: &Self) -> Result<Self, BitStringLenMismatch>

Returns self & rhs without mutating either input.

pub fn and_assign(&mut self, rhs: &Self) -> Result<(), BitStringLenMismatch>

Replaces self with self & rhs.

impl BitString

pub fn count_ones(&self) -> usize

Returns the number of bits set to 1.

pub fn count_zeros(&self) -> usize

Returns the number of bits set to 0.

impl BitString

pub fn not(&self) -> Self

Returns !self without mutating the input.

pub fn not_assign(&mut self)

Replaces self with !self.

impl BitString

pub fn or(&self, rhs: &Self) -> Result<Self, BitStringLenMismatch>

pub fn or_assign(&mut self, rhs: &Self) -> Result<(), BitStringLenMismatch>

impl BitString

pub fn shl(&self, amount: usize) -> Self

Returns self << amount, filling new bits with zero.

pub fn shl_assign(&mut self, amount: usize)

Replaces self with self << amount, filling new bits with zero.

impl BitString

pub fn shr(&self, amount: usize) -> Self

Returns self >> amount, filling new bits with zero.

pub fn shr_assign(&mut self, amount: usize)

Replaces self with self >> amount, filling new bits with zero.

impl BitString

pub fn xor(&self, rhs: &Self) -> Result<Self, BitStringLenMismatch>

pub fn xor_assign(&mut self, rhs: &Self) -> Result<(), BitStringLenMismatch>

impl BitString

pub fn from_words(words: &[u64], len: usize) -> Option<Self>

Constructs a bit string from packed little-endian words.

The input must contain exactly enough words for len. Unused high bits in the last word are masked out.

impl BitString

pub fn new() -> Self

impl BitString

pub fn repeat(value: bool, bit_len: usize) -> Self

pub fn zeros(bit_len: usize) -> Self

pub fn ones(bit_len: usize) -> Self

impl BitString

pub fn push_bit_string(&mut self, rhs: &Self)

Appends the bits of rhs to self.

When self has spare capacity the operation is performed in-place without allocation.

pub fn insert_bit_string(&mut self, index: usize, rhs: &Self)

Inserts the bits of rhs at index, shifting the tail right.

index is clamped to [0, self.bit_len()] — an out-of-bounds index inserts at the end (equivalent to push_bit_string).

When spare capacity is available and rhs.bit_len() >= 64, the tail is shifted in-place without allocation.

pub fn split_off(&mut self, at: usize) -> Self

Splits self at at, returning the tail as a new BitString.

at is clamped to [0, self.bit_len()] — an out-of-bounds index returns an empty bit string and leaves self unchanged.

impl BitString

pub fn drain_interval(&self, interval: UsizeCO) -> Self

Borrowing variant: returns a new BitString with interval removed; self is unchanged.

The interval is clamped to [0, self.bit_len()). An interval that lies entirely beyond the bit string length returns a clone of self.

pub fn drain_interval_assign(&mut self, interval: UsizeCO)

Assigning variant: removes interval from self.

Always allocates a fresh buffer and swaps it in — profiling shows that copy_bits → paste_to via memcpy beats any in-place bit-shifting approach for typical workloads.

impl BitString

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

Inserts a single bit at index, shifting the tail right.

index is clamped to [0, self.bit_len()] — an out-of-bounds index pushes at the end.

pub fn remove(&mut self, index: usize) -> bool

Removes the bit at index, shifting the tail left.

Returns false (without modifying self) when index >= self.bit_len().

impl BitString

pub fn push(&mut self, value: bool)

Appends a single bit to the end.

Panics if the bit string length would overflow usize.

pub fn pop(&mut self) -> Option<bool>

Removes and returns the last bit, or None if the bit string is empty.

impl BitString

pub fn replace_interval(&self, interval: UsizeCO, replacement: &Self) -> Self

Borrowing variant: returns a new BitString; self is unchanged.

pub fn replace_interval_assign(&mut self, interval: UsizeCO, replacement: &Self)

Assigning variant: replaces the interval in-place.

When the replacement length equals the (clamped) interval length the operation is performed in-place without allocation. Otherwise a fresh buffer is allocated and swapped in.

impl BitString

pub fn replace(&self, start: usize, replacement: &Self) -> Self

Borrowing variant of replace.

pub fn replace_assign(&mut self, start: usize, replacement: &Self)

Assigning variant of replace.

impl BitString

pub fn retain<F>(&mut self, f: F)

where F: FnMut(bool) -> bool,

Retains only the bits for which f(bit) returns true.

Bits are processed in order and written back contiguously, preserving the relative order of retained bits. Operates bit-by-bit.

f may be FnMut — the predicate is allowed to carry mutable state.

impl BitString

pub fn set(&mut self, index: usize, value: bool) -> Option<bool>

Sets the bit at index to value, returning the previous bit.

Returns None (without modifying self) when index >= self.bit_len().

pub fn set_chunk(&mut self, bit_start: usize, value: u64, len: usize)

Writes len bits of value starting at bit_start, OR-ing them with the existing bits. Bits beyond self.len() are ignored.

Only the low len bits of value are used; higher bits are masked out.

impl BitString

pub fn slice(&self, interval: UsizeCO) -> Self

Returns a new BitString containing the bits in interval.

The interval is clamped to [0, self.bit_len()]. An interval that lies entirely beyond the bit string returns an empty result.

pub fn slice_from(&self, start: usize) -> Self

Returns a new BitString containing bits from start to the end.

start is clamped to self.bit_len() — an out-of-bounds index returns an empty result.

pub fn slice_until(&self, end: usize) -> Self

Returns a new BitString containing bits from the start to end.

end is clamped to self.bit_len() — a value beyond the bit string returns all bits.

impl BitString

pub fn truncate(&mut self, len: usize)

Truncates self to len bits, discarding the tail.

len is clamped to self.bit_len() — a larger value is a no-op.

pub fn clear(&mut self)

Clears all bits, resetting self to an empty bit string.

impl BitString

pub fn iter(&self) -> Iter<'_>

impl BitString

pub fn contains(&self, needle: &Self) -> bool

pub fn find(&self, needle: &Self) -> Option<usize>

pub fn rfind(&self, needle: &Self) -> Option<usize>

impl BitString

pub fn matches_at(&self, index: usize, pattern: &Self) -> bool

pub fn starts_with(&self, prefix: &Self) -> bool

pub fn ends_with(&self, suffix: &Self) -> bool

impl BitString

pub fn strip_prefix(&self, prefix: &Self) -> Option<Self>

pub fn strip_suffix(&self, suffix: &Self) -> Option<Self>

Trait Implementations

impl Clone for BitString

fn clone(&self) -> BitString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitString

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

Formats the value using the given formatter.

impl Default for BitString

fn default() -> Self

Returns the “default value” for a type.

impl Display for BitString

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

Formats the value using the given formatter.

impl Eq for BitString

impl<'a> Extend<&'a bool> for BitString

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = &'a bool>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<bool> for BitString

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = bool>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<&[bool]> for BitString

fn from(values: &[bool]) -> Self

Converts to this type from the input type.

impl<const N: usize> From<[bool; N]> for BitString

fn from(values: [bool; N]) -> Self

Converts to this type from the input type.

impl FromIterator<bool> for BitString

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = bool>,

Creates a value from an iterator.

impl FromStr for BitString

type Err = ParseBitStringError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for BitString

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<'a> IntoIterator for &'a BitString

type Item = bool

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for BitString

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

impl TryFrom<&str> for BitString

type Error = ParseBitStringError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.