Struct bv::adapter::BoolAdapter

pub struct BoolAdapter<Block, T> { /* fields omitted */ }

Adapts a sequence of bools (e.g., &[bool]) to emulate a bit vector.

In particular, this adapter implements Bits, BitsMut, and BitsPush as appropriate. It implement PartialEq<T> for all T: Bits<Block=Block>. It does not, however, implement slicing, so slice before you adapt.

Note that a bare Vec<bool> or &[bool] already implements Bits, etc., with a Block type of u8. This means that it is only compatible with other u8-based bit vectors. BoolAdapter is instead parametrized by the block type, so it works with bit vectors, slices, and adapters of any uniform block type.

Methods

impl<Block: BlockType, T> BoolAdapter<Block, T>

pub fn new(bits: T) -> Self

Creates a new BoolAdapter from an underlying sequence of bools.

Note that the BoolAdapter derefs to the underlying bool sequence.

Examples

use bv::BitSliceable;
use bv::adapter::BoolAdapter;

let array = [0b101usize];
let bv1 = BoolAdapter::new(vec![true, false, true]);
let bv2 = array.bit_slice(0..3);
assert_eq!( bv1, bv2 );

pub fn into_inner(self) -> T

Gets the underlying bool sequence object back out of a BoolAdapter.

Trait Implementations

impl<Block: BlockType> Bits for BoolAdapter<Block, Vec<bool>>

type Block = Block

The underlying block type used to store the bits of the vector.

fn bit_len(&self) -> u64

The length of the slice in bits.

fn get_bit(&self, position: u64) -> bool

Gets the bit at position

fn block_len(&self) -> usize

The length of the slice in blocks.

fn get_block(&self, position: usize) -> Self::Block

Gets the block at position, masked as necessary.

fn get_raw_block(&self, position: usize) -> Self::Block

Gets the block at position, without masking.

fn get_bits(&self, start: u64, count: usize) -> Self::Block

Gets count bits starting at bit index start, interpreted as a little-endian integer.

fn to_bit_vec(&self) -> BitVec<Self::Block>

Copies the bits into a new allocated [BitVec].

impl<'a, Block: BlockType> Bits for BoolAdapter<Block, &'a mut Vec<bool>>

type Block = Block

The underlying block type used to store the bits of the vector.

fn bit_len(&self) -> u64

The length of the slice in bits.

fn get_bit(&self, position: u64) -> bool

Gets the bit at position

fn block_len(&self) -> usize

The length of the slice in blocks.

fn get_block(&self, position: usize) -> Self::Block

Gets the block at position, masked as necessary.

fn get_raw_block(&self, position: usize) -> Self::Block

Gets the block at position, without masking.

fn get_bits(&self, start: u64, count: usize) -> Self::Block

Gets count bits starting at bit index start, interpreted as a little-endian integer.

fn to_bit_vec(&self) -> BitVec<Self::Block>

Copies the bits into a new allocated [BitVec].

impl<'a, Block: BlockType> Bits for BoolAdapter<Block, &'a mut [bool]>

type Block = Block

The underlying block type used to store the bits of the vector.

fn bit_len(&self) -> u64

The length of the slice in bits.

fn get_bit(&self, position: u64) -> bool

Gets the bit at position

fn block_len(&self) -> usize

The length of the slice in blocks.

fn get_block(&self, position: usize) -> Self::Block

Gets the block at position, masked as necessary.

fn get_raw_block(&self, position: usize) -> Self::Block

Gets the block at position, without masking.

fn get_bits(&self, start: u64, count: usize) -> Self::Block

Gets count bits starting at bit index start, interpreted as a little-endian integer.

fn to_bit_vec(&self) -> BitVec<Self::Block>

Copies the bits into a new allocated [BitVec].

impl<'a, Block: BlockType> Bits for BoolAdapter<Block, &'a [bool]>

type Block = Block

The underlying block type used to store the bits of the vector.

fn bit_len(&self) -> u64

The length of the slice in bits.

fn get_bit(&self, position: u64) -> bool

Gets the bit at position

fn block_len(&self) -> usize

The length of the slice in blocks.

fn get_block(&self, position: usize) -> Self::Block

Gets the block at position, masked as necessary.

fn get_raw_block(&self, position: usize) -> Self::Block

Gets the block at position, without masking.

fn get_bits(&self, start: u64, count: usize) -> Self::Block

Gets count bits starting at bit index start, interpreted as a little-endian integer.

fn to_bit_vec(&self) -> BitVec<Self::Block>

Copies the bits into a new allocated [BitVec].

impl<Block: BlockType> BitsMut for BoolAdapter<Block, Vec<bool>>

fn set_bit(&mut self, position: u64, value: bool)

Sets the bit at position to value.

fn set_block(&mut self, position: usize, value: Self::Block)

Sets the block at position to value.

fn set_bits(&mut self, start: u64, count: usize, value: Self::Block)

Sets count bits starting at bit index start, interpreted as a little-endian integer.

impl<'a, Block: BlockType> BitsMut for BoolAdapter<Block, &'a mut Vec<bool>>

fn set_bit(&mut self, position: u64, value: bool)

Sets the bit at position to value.

fn set_block(&mut self, position: usize, value: Self::Block)

Sets the block at position to value.

fn set_bits(&mut self, start: u64, count: usize, value: Self::Block)

Sets count bits starting at bit index start, interpreted as a little-endian integer.

impl<'a, Block: BlockType> BitsMut for BoolAdapter<Block, &'a mut [bool]>

fn set_bit(&mut self, position: u64, value: bool)

Sets the bit at position to value.

fn set_block(&mut self, position: usize, value: Self::Block)

Sets the block at position to value.

fn set_bits(&mut self, start: u64, count: usize, value: Self::Block)

Sets count bits starting at bit index start, interpreted as a little-endian integer.

impl<Block: BlockType> BitsPush for BoolAdapter<Block, Vec<bool>>

fn push_bit(&mut self, value: bool)

Adds the given bit to the end of the bit vector.

fn pop_bit(&mut self) -> Option<bool>

Removes and returns the last bit, if any.

fn align_block(&mut self, value: bool)

Pushes value 0 or more times until the size of the bit vector is block-aligned.

fn push_block(&mut self, value: Self::Block)

Pushes the given block onto the end of the bit vector.

impl<'a, Block: BlockType> BitsPush for BoolAdapter<Block, &'a mut Vec<bool>>

fn push_bit(&mut self, value: bool)

Adds the given bit to the end of the bit vector.

fn pop_bit(&mut self) -> Option<bool>

Removes and returns the last bit, if any.

fn align_block(&mut self, value: bool)

Pushes value 0 or more times until the size of the bit vector is block-aligned.

fn push_block(&mut self, value: Self::Block)

Pushes the given block onto the end of the bit vector.

impl<Block: Clone, T: Clone> Clone for BoolAdapter<Block, T>

fn clone(&self) -> BoolAdapter<Block, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Block, T, U> PartialEq<U> for BoolAdapter<Block, T> where
    Block: BlockType,
    U: Bits<Block = Block>,
    Self: Bits<Block = Block>, 

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<Block: Debug, T: Debug> Debug for BoolAdapter<Block, T>

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

Formats the value using the given formatter.

impl<Block, T> Deref for BoolAdapter<Block, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<Block, T> DerefMut for BoolAdapter<Block, T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.