Trait bv::Bits[−][src]

[+] Show declaration

pub trait Bits {
    type Block: BlockType;
    fn bit_len(&self) -> u64;

    fn block_len(&self) -> usize { ... }
    fn get_bit(&self, position: u64) -> bool { ... }
    fn get_block(&self, position: usize) -> Self::Block { ... }
    fn get_raw_block(&self, position: usize) -> Self::Block { ... }
    fn get_bits(&self, start: u64, count: usize) -> Self::Block { ... }
    fn to_bit_vec(&self) -> BitVec<Self::Block> { ... }
}

[−]

Read-only bit vector operations.

Minimal complete definition is:

bit_len and
get_block or get_bit.

Note that get_block in terms of get_bit is inefficient, and thus you should implement get_block directly if possible.

Associated Types

`type Block: BlockType`[src][−]

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

Required methods

`fn bit_len(&self) -> u64`[src][−]

The length of the slice in bits.

Provided methods

`fn block_len(&self) -> usize`[src][−]

The length of the slice in blocks.

`fn get_bit(&self, position: u64) -> bool`[src][−]

Gets the bit at position

The default implementation calls get_block and masks out the correct bit.

Panics

Panics if position is out of bounds.

`fn get_block(&self, position: usize) -> Self::Block`[src][−]

Gets the block at position, masked as necessary.

The bits are laid out Block::nbits() per block, with the notional zeroth bit in the least significant position. If self.bit_len() is not a multiple of Block::nbits() then the last block will contain extra zero bits that are not part of the bit vector.

The default implementation calls get_raw_block, but you can override with something more efficient, for example if masking is unnecessary.

Panics

Panics if position is out of bounds.

`fn get_raw_block(&self, position: usize) -> Self::Block`[src][−]

Gets the block at position, without masking.

The default implementation of this method just delegates to [get_block](#method .get_block), which means it in fact does mask out extraneous bits. However, particular implementors may override this method to provide a more efficient implementation when one is possible.

Panics

Panics if position is out of bounds.

`fn get_bits(&self, start: u64, count: usize) -> Self::Block`[src][−]

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

Panics

Panics if the bit span goes out of bounds.

`fn to_bit_vec(&self) -> BitVec<Self::Block>`[src][−]

Copies the bits into a new allocated BitVec.

Trait bv::Bits[−][src]

Associated Types

type Block: BlockType[src][−]

Required methods

fn bit_len(&self) -> u64[src][−]

Provided methods

fn block_len(&self) -> usize[src][−]

fn get_bit(&self, position: u64) -> bool[src][−]

Panics

fn get_block(&self, position: usize) -> Self::Block[src][−]

Panics

fn get_raw_block(&self, position: usize) -> Self::Block[src][−]

Panics

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

Panics

fn to_bit_vec(&self) -> BitVec<Self::Block>[src][−]

Implementations on Foreign Types

impl<'a, T: Bits + ?Sized> Bits for &'a T[src][−]

type Block = T::Block

fn bit_len(&self) -> u64[src]

fn block_len(&self) -> usize[src]

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

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

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

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

impl<'a, T: Bits + ?Sized> Bits for &'a mut T[src][−]

type Block = T::Block

fn bit_len(&self) -> u64[src]

fn block_len(&self) -> usize[src]

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

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

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

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

impl<Block: BlockType> Bits for Box<dyn Bits<Block = Block>>[src][−]

type Block = Block

fn bit_len(&self) -> u64[src]

fn block_len(&self) -> usize[src]

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

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

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

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

impl<Block: BlockType> Bits for Box<dyn BitsMut<Block = Block>>[src][−]

type Block = Block

fn bit_len(&self) -> u64[src]

fn block_len(&self) -> usize[src]

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

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

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

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

impl<Block: BlockType> Bits for [Block][src][−]

type Block = Block

fn bit_len(&self) -> u64[src]

fn block_len(&self) -> usize[src]

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

fn get_block(&self, position: usize) -> Block[src]

impl<Block: BlockType> Bits for Vec<Block>[src][−]

type Block = Block

fn bit_len(&self) -> u64[src]

fn block_len(&self) -> usize[src]

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

fn get_block(&self, position: usize) -> Block[src]

fn get_raw_block(&self, position: usize) -> Block[src]

impl Bits for [bool][src][−]

type Block = u8

fn bit_len(&self) -> u64[src]

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

impl Bits for Vec<bool>[src][−]

type Block = u8

fn bit_len(&self) -> u64[src]

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

impl<Block: BlockType> Bits for [Block; 0][src][−]

type Block = Block

fn bit_len(&self) -> u64[src]

fn block_len(&self) -> usize[src]

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

impl Bits for [bool; 0][src][−]

type Block = u8

fn bit_len(&self) -> u64[src]

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

impl<Block: BlockType> Bits for [Block; 1][src][−]

`type Block: BlockType`[src][−]

`fn bit_len(&self) -> u64`[src][−]

`fn block_len(&self) -> usize`[src][−]

`fn get_bit(&self, position: u64) -> bool`[src][−]

`fn get_block(&self, position: usize) -> Self::Block`[src][−]

`fn get_raw_block(&self, position: usize) -> Self::Block`[src][−]

`fn get_bits(&self, start: u64, count: usize) -> Self::Block`[src][−]

`fn to_bit_vec(&self) -> BitVec<Self::Block>`[src][−]

`impl<'a, T: Bits + ?Sized> Bits for &'a T`[src][−]

`type Block = T::Block`

`fn bit_len(&self) -> u64`[src]

`fn block_len(&self) -> usize`[src]

`fn get_bit(&self, position: u64) -> bool`[src]

`fn get_block(&self, position: usize) -> Self::Block`[src]

`fn get_raw_block(&self, position: usize) -> Self::Block`[src]

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

`impl<'a, T: Bits + ?Sized> Bits for &'a mut T`[src][−]

`type Block = T::Block`

`fn bit_len(&self) -> u64`[src]

`fn block_len(&self) -> usize`[src]

`fn get_bit(&self, position: u64) -> bool`[src]

`fn get_block(&self, position: usize) -> Self::Block`[src]

`fn get_raw_block(&self, position: usize) -> Self::Block`[src]

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

`impl<Block: BlockType> Bits for Box<dyn Bits<Block = Block>>`[src][−]

`type Block = Block`

`fn bit_len(&self) -> u64`[src]

`fn block_len(&self) -> usize`[src]

`fn get_bit(&self, position: u64) -> bool`[src]

`fn get_block(&self, position: usize) -> Self::Block`[src]

`fn get_raw_block(&self, position: usize) -> Self::Block`[src]

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

`impl<Block: BlockType> Bits for Box<dyn BitsMut<Block = Block>>`[src][−]

`type Block = Block`

`fn bit_len(&self) -> u64`[src]

`fn block_len(&self) -> usize`[src]

`fn get_bit(&self, position: u64) -> bool`[src]

`fn get_block(&self, position: usize) -> Self::Block`[src]

`fn get_raw_block(&self, position: usize) -> Self::Block`[src]

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

`impl<Block: BlockType> Bits for [Block]`[src][−]

`type Block = Block`

`fn bit_len(&self) -> u64`[src]

`fn block_len(&self) -> usize`[src]

`fn get_bit(&self, position: u64) -> bool`[src]

`fn get_block(&self, position: usize) -> Block`[src]

`impl<Block: BlockType> Bits for Vec<Block>`[src][−]

`type Block = Block`

`fn bit_len(&self) -> u64`[src]

`fn block_len(&self) -> usize`[src]

`fn get_bit(&self, position: u64) -> bool`[src]

`fn get_block(&self, position: usize) -> Block`[src]

`fn get_raw_block(&self, position: usize) -> Block`[src]

`impl Bits for [bool]`[src][−]

`type Block = u8`

`fn bit_len(&self) -> u64`[src]

`fn get_bit(&self, position: u64) -> bool`[src]

`impl Bits for Vec<bool>`[src][−]

`type Block = u8`

`fn bit_len(&self) -> u64`[src]

`fn get_bit(&self, position: u64) -> bool`[src]

`impl<Block: BlockType> Bits for [Block; 0]`[src][−]

`type Block = Block`

`fn bit_len(&self) -> u64`[src]

`fn block_len(&self) -> usize`[src]

`fn get_block(&self, position: usize) -> Self::Block`[src]

`impl Bits for [bool; 0]`[src][−]

`type Block = u8`

`fn bit_len(&self) -> u64`[src]

`fn get_bit(&self, position: u64) -> bool`[src]

`impl<Block: BlockType> Bits for [Block; 1]`[src][−]

`type Block = Block`

`fn bit_len(&self) -> u64`[src]

`fn block_len(&self) -> usize`[src]

`fn get_block(&self, position: usize) -> Self::Block`[src]

`impl Bits for [bool; 1]`[src][−]

`type Block = u8`

`fn bit_len(&self) -> u64`[src]

`fn get_bit(&self, position: u64) -> bool`[src]

`impl<Block: BlockType> Bits for [Block; 2]`[src][−]