[−][src]Trait bv::BitsExt

pub trait BitsExt: Bits {
    fn bit_concat<Other>(&self, other: Other) -> BitConcat<&Self, Other>
    where
        Other: Bits<Block = Self::Block>,
    { ... }
    fn into_bit_concat<Other>(self, other: Other) -> BitConcat<Self, Other>
    where
        Self: Sized,
        Other: Bits<Block = Self::Block>,
    { ... }
    fn bit_pad(&self, len: u64) -> BitConcat<&Self, BitFill<Self::Block>> { ... }
    fn into_bit_pad(self, len: u64) -> BitConcat<Self, BitFill<Self::Block>>
    where
        Self: Sized,
    { ... }
    fn bit_not(&self) -> BitNot<&Self> { ... }
    fn into_bit_not(self) -> BitNot<Self>
    where
        Self: Sized,
    { ... }
    fn bit_and<Other>(&self, other: Other) -> BitAnd<&Self, Other>
    where
        Other: Bits<Block = Self::Block>,
    { ... }
    fn into_bit_and<Other>(self, other: Other) -> BitAnd<Self, Other>
    where
        Self: Sized,
        Other: Bits<Block = Self::Block>,
    { ... }
    fn bit_or<Other>(&self, other: Other) -> BitOr<&Self, Other>
    where
        Other: Bits<Block = Self::Block>,
    { ... }
    fn into_bit_or<Other>(self, other: Other) -> BitOr<Self, Other>
    where
        Self: Sized,
        Other: Bits<Block = Self::Block>,
    { ... }
    fn bit_xor<Other>(&self, other: Other) -> BitXor<&Self, Other>
    where
        Other: Bits<Block = Self::Block>,
    { ... }
    fn into_bit_xor<Other>(self, other: Other) -> BitXor<Self, Other>
    where
        Self: Sized,
        Other: Bits<Block = Self::Block>,
    { ... }
    fn bit_zip<Other, F>(&self, other: Other, fun: F) -> BitZip<&Self, Other, F>
    where
        Other: Bits<Block = Self::Block>,
        F: Fn(Self::Block, Self::Block, usize) -> Self::Block,
    { ... }
    fn into_bit_zip<Other, F>(
        self, 
        other: Other, 
        fun: F
    ) -> BitZip<Self, Other, F>
    where
        Self: Sized,
        Other: Bits<Block = Self::Block>,
        F: Fn(Self::Block, Self::Block, usize) -> Self::Block,
    { ... }
}

Extension trait for adapter operations on bit slices.

The methods return lazy adapter objects that query the underlying bit vectors and perform operations as needed. To eagerly evaluate a result, copy it into a vector using the Bits::to_bit_vec method, as in the example below.

This trait is currently pub used from the adapter module, but that alias is deprecated.

Examples

use bv::*;

let bv1: BitVec = bit_vec![false, false, true, true];
let bv2: BitVec = bit_vec![false, true, false, true];

let and_bv = bv1.bit_and(&bv2);

assert_eq!( and_bv[0], false );
assert_eq!( and_bv[1], false );
assert_eq!( and_bv[2], false );
assert_eq!( and_bv[3], true );

let bv3 = and_bv.to_bit_vec();
assert_eq!( bv3, bit_vec![false, false, false, true] );

Provided methods

`fn bit_concat<Other>(&self, other: Other) -> BitConcat<&Self, Other> where Other: Bits<Block = Self::Block>,`

Concatenates two bit vectors, with the bits of self followed by the bits of other.

`fn into_bit_concat<Other>(self, other: Other) -> BitConcat<Self, Other> where Self: Sized, Other: Bits<Block = Self::Block>,`

Concatenates two bit vectors, with the bits of self followed by the bits of other.

Consumes self.

`fn bit_pad(&self, len: u64) -> BitConcat<&Self, BitFill<Self::Block>>`

Pads self with 0s on the right to reach at least len bits in length.

If self is already long enough, the length is unchanged.

`fn into_bit_pad(self, len: u64) -> BitConcat<Self, BitFill<Self::Block>> where Self: Sized,`

Pads self with 0s on the right to reach at least len bits in length.

If self is already long enough, the length is unchanged.

Consumes self.

`fn bit_not(&self) -> BitNot<&Self>`

Returns an object that inverts the values of all the bits in self.

`fn into_bit_not(self) -> BitNot<Self> where Self: Sized,`

Returns an object that inverts the values of all the bits in self.

Consumes self.