Struct Unsigned

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

Unsigned bitvector.

The number of bits is specified in the generic parameter L. Unsigned bitvectors support bitwise operations and wrapping-arithmetic operations. Logical bit extension is also possible (any new bits are zero). Signed bitvectors be converted into Unsigned or Bitvector.

Implementations

impl<const L: u32> Unsigned<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 Unsigned<L>

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

Performs wrapping addition.

type Output = Unsigned<L>

The resulting type after applying the + operator.

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

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

Performs bitwise AND.

type Output = Unsigned<L>

The resulting type after applying the & operator.

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

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

Performs bitwise OR.

type Output = Unsigned<L>

The resulting type after applying the | operator.

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

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

Performs bitwise XOR.

type Output = Unsigned<L>

The resulting type after applying the ^ operator.

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

fn clone(&self) -> Unsigned<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 Unsigned<L>

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

Formats the value using the given formatter.

impl<const L: u32> Div for Unsigned<L>

fn div(self, rhs: Unsigned<L>) -> Self::Output

Performs wrapping unsigned division.

While the division is defined to be wrapping, no wrapping actually can happen in unsigned division.

Panics

Panics if rhs is zero.

type Output = Unsigned<L>

The resulting type after applying the / operator.

impl<const L: u32, const X: u32> Ext<X> for Unsigned<L>

fn ext(self) -> Self::Output

Extends or narrows the bit-vector.

If an extension is performed, the upper bits will be zero.

type Output = Unsigned<X>

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 Unsigned<L>

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

Converts the signedness information from Signed to Unsigned.

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> From<Unsigned<L>> for Signed<L>

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

Converts the signedness information from Unsigned to Signed.

impl<const L: u32> Hash for Unsigned<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 L: u32> Mul for Unsigned<L>

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

Performs wrapping multiplication.

type Output = Unsigned<L>

The resulting type after applying the * operator.

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

fn not(self) -> Self::Output

Performs bitwise NOT.

type Output = Unsigned<L>

The resulting type after applying the ! operator.

impl<const L: u32> Ord for Unsigned<L>

fn cmp(&self, other: &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<const L: u32> PartialEq for Unsigned<L>

fn eq(&self, other: &Unsigned<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> PartialOrd for Unsigned<L>

fn partial_cmp(&self, other: &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<const L: u32> Rem for Unsigned<L>

fn rem(self, rhs: Unsigned<L>) -> Self::Output

Performs wrapping unsigned remainer.

While the remainder is defined to be wrapping, no wrapping actually can happen in unsigned remainder.

Panics

Panics if rhs is zero.

type Output = Unsigned<L>

The resulting type after applying the % operator.

impl<const L: u32> Shl for Unsigned<L>

fn shl(self, rhs: Unsigned<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 = Unsigned<L>

The resulting type after applying the << operator.

impl<const L: u32> Shr for Unsigned<L>

fn shr(self, rhs: Unsigned<L>) -> Self::Output

Performs a logic right shift.

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_shr on unsigned primitives. It is planned to restrict the bit-width in the future so that this edge case can never occur.

type Output = Unsigned<L>

The resulting type after applying the >> operator.

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

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

Performs wrapping subtraction.

type Output = Unsigned<L>

The resulting type after applying the - operator.

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

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

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