Struct Bitvector

pub struct Bitvector<const L: u32>(/* private fields */);

Bitvector without signedness information.

The number of bits is specified in the generic parameter L. Bitvectors support bitwise operations and wrapping-arithmetic operations. Only operations where the behaviour of signed and unsigned numbers match are implemented. For others, conversion into Unsigned or Signed is necessary. Bit-extension is not possible directly, as signed and unsigned bitvectors are extended differently.

Implementations

impl<const L: u32> Bitvector<L>

pub fn new(value: u64) -> Self

Creates a new bitvector with the given value.

Panics if the value does not fit into the type.

Trait Implementations

impl<const L: u32> Add for Bitvector<L>

fn add(self, rhs: Bitvector<L>) -> Self::Output

Performs wrapping addition.

type Output = Bitvector<L>

The resulting type after applying the + operator.

impl<const L: u32> BitAnd for Bitvector<L>

fn bitand(self, rhs: Bitvector<L>) -> Self::Output

Performs bitwise AND.

type Output = Bitvector<L>

The resulting type after applying the & operator.

impl<const L: u32> BitOr for Bitvector<L>

fn bitor(self, rhs: Bitvector<L>) -> Self::Output

Performs bitwise OR.

type Output = Bitvector<L>

The resulting type after applying the | operator.

impl<const L: u32> BitXor for Bitvector<L>

fn bitxor(self, rhs: Bitvector<L>) -> Self::Output

Performs bitwise XOR.

type Output = Bitvector<L>

The resulting type after applying the ^ operator.

impl<const L: u32> Clone for Bitvector<L>

fn clone(&self) -> Bitvector<L>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const L: u32> Debug for Bitvector<L>

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

Formats the value using the given formatter.

impl<const L: u32> From<Bitvector<L>> for Signed<L>

fn from(value: Bitvector<L>) -> Self

Adds signedness information to Bitvector.

impl<const L: u32> From<Bitvector<L>> for Unsigned<L>

fn from(value: Bitvector<L>) -> Self

Adds signedness information to Bitvector.

impl<const L: u32> From<Signed<L>> for Bitvector<L>

fn from(value: Signed<L>) -> Self

Drops the signedness information from Signed.

impl<const L: u32> From<Unsigned<L>> for Bitvector<L>

fn from(value: Unsigned<L>) -> Self

Drops the signedness information from Unsigned.

impl<const L: u32> Hash for Bitvector<L>

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<const I: u32, const L: u32> Index<Bitvector<I>> for BitvectorArray<I, L>

type Output = Bitvector<L>

The returned type after indexing.

fn index(&self, index: Bitvector<I>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<const I: u32, const L: u32> IndexMut<Bitvector<I>> for BitvectorArray<I, L>

fn index_mut(&mut self, index: Bitvector<I>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<const L: u32> Mul for Bitvector<L>

fn mul(self, rhs: Bitvector<L>) -> Self::Output

Performs wrapping multiplication.

type Output = Bitvector<L>

The resulting type after applying the * operator.

impl<const L: u32> Not for Bitvector<L>

fn not(self) -> Self::Output

Performs bitwise NOT.

type Output = Bitvector<L>

The resulting type after applying the ! operator.

impl<const L: u32> PartialEq for Bitvector<L>

fn eq(&self, other: &Bitvector<L>) -> 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<const L: u32> Shl for Bitvector<L>

fn shl(self, rhs: Bitvector<L>) -> Self::Output

Performs a left shift.

Unlike a right shift, where the behaviour is dependent on signedness, the left shift has the same behaviour: shifted-out bits on the left are discarded and zeros are shifted in on the right.

The right-hand side operand is interpreted as unsigned and if it is equal or greater to the bit-width, the result is all-zeros, as in Rust unbounded_shl. It is planned to restrict the bit-width in the future so that this edge case can never occur.

type Output = Bitvector<L>

The resulting type after applying the << operator.

impl<const L: u32> Sub for Bitvector<L>

fn sub(self, rhs: Bitvector<L>) -> Self::Output

Performs wrapping subtraction.

type Output = Bitvector<L>

The resulting type after applying the - operator.

impl<const L: u32> Copy for Bitvector<L>

impl<const L: u32> Eq for Bitvector<L>

impl<const L: u32> StructuralPartialEq for Bitvector<L>