Struct BitLengthString

pub struct BitLengthString<W: FixedBitString> { /* private fields */ }

Available on crate feature fixed only.

Extend a FixedBitString to a BitString by also storing a length.

Implementations

impl<W: FixedBitString> BitLengthString<W>

pub fn new(bits: W, len: usize) -> Self

Create new dynamic-length bit string from fixed bit string and a length.

The bits in bits after len bits are set to false.

Panics

Panics if len > W::len().

pub fn contains(&self, bits: &W) -> bool

check whether another bit string bits is prefixed by self

pub fn bits(&self) -> &W

get read access to the bits

pub fn len(&self) -> usize

length of bit string (same as BitString::len())

Trait Implementations

impl<W: FixedBitString> BitString for BitLengthString<W>

fn get(&self, ndx: usize) -> bool

Get the ndxth bit.

fn set(&mut self, ndx: usize, bit: bool)

Set the ndxth bit to bit.

fn flip(&mut self, ndx: usize)

Flips the ndxth bit.

fn len(&self) -> usize

Current length of the bit string in bits.

fn clip(&mut self, len: usize)

Set current length to len.

fn append(&mut self, bit: bool)

Append a bit.

fn null() -> Self

Create a new zero-length bit string.

fn shared_prefix_len(&self, other: &Self) -> usize

Length of the longest shared prefix of two bit strings.

fn shared_prefix(&self, other: &Self) -> Self

where Self: Clone,

Longest shared prefix of two bit strings.

fn subset_cmp(&self, other: &Self) -> Option<Ordering>

Partial ordering on bit strings.

fn lexicographic_cmp(&self, other: &Self) -> Ordering

Lexicographic ordering on bit strings.

impl<W: Clone + FixedBitString> Clone for BitLengthString<W>

fn clone(&self) -> BitLengthString<W>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<W: Debug + FixedBitString> Debug for BitLengthString<W>

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

Formats the value using the given formatter.

impl<W: FixedBitString> Default for BitLengthString<W>

fn default() -> Self

Returns the “default value” for a type.

impl<W: Hash + FixedBitString> Hash for BitLengthString<W>

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<W: FixedBitString> Ord for BitLengthString<W>

fn cmp(&self, rhs: &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<W: FixedBitString> PartialEq for BitLengthString<W>

fn eq(&self, rhs: &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<W: FixedBitString> PartialOrd for BitLengthString<W>

fn partial_cmp(&self, rhs: &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<W: FixedBitString> Eq for BitLengthString<W>