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.

Examples found in repository

examples/timed_panic.rs (line 43)

        fn init(&self, input: &Input) -> State {
            State {
                counter: Unsigned::<3>::new(0),
                value: Unsigned::<2>::new(0),
            }
        }

        fn next(&self, state: &State, input: &Input) -> State {
            if state.value == Unsigned::<2>::new(3) {
                ::std::panic!("Value must not be 3");
            }

            let next_counter = state.counter + Unsigned::<3>::new(1);
            let mut next_value = state.value;
            if state.counter == Unsigned::<3>::new(7) {
                next_value = input.value;
            }
            State {
                counter: next_counter,
                value: next_value,
            }
        }

examples/counter.rs (line 68)

        fn init(&self, input: &Input) -> State {
            State {
                value: Unsigned::<8>::new(0),
                unused: Clone::clone(&input.unused),
            }
        }

        // Machine step. Given a state and an input, the next state is generated.
        // Again, the function must be pure.
        //
        // Here, the value is incremented if input increment field is 1.
        // If it reaches 157, it is immediately reset to 0. The unused array
        // is again taken from the input, i.e. can have any values, and the
        // values do not have to match the previous ones.
        fn next(&self, state: &State, input: &Input) -> State {
            // The increment is extended to 8 bits (zero-extension because
            // it is Unsigned), then added to the value in the current state.
            // Currently, it must be called using associated function call,
            // i.e. Ext::<8>::ext(a), rather than method call input.increment.ext()
            let mut next_value = state.value + Ext::<8>::ext(input.increment);
            // If the next value is 157, it is immediately set to 0.
            if next_value == Unsigned::<8>::new(157) {
                next_value = Unsigned::<8>::new(0);
            }

            // The clone function is one of the few std functions supported
            // by machine-check. Currently, the functions can only be called
            // using associated function call, i.e. Clone::clone(&a),
            // rather than the usually used method call a.clone().
            let unused = Clone::clone(&input.unused);

            // The new state is constructed with the new value and unused fields.
            State {
                value: next_value,
                unused,
            }
        }

examples/recovery.rs (line 66)

        fn init(&self, _input: &Input) -> State {
            State {
                max_value: Unsigned::<4>::new(0),
                unused: Bitvector::<4>::new(0),
                free_counter: Unsigned::<4>::new(0),
            }
        }

        fn next(&self, state: &State, input: &Input) -> State {
            let input_value = input.value;

            // If the maximum value is smaller than the input value,
            // update it to the input value.
            let mut next_max = state.max_value;
            if next_max < input_value {
                next_max = input_value;
            }
            // If the reset input is asserted and it is actually enabled in the system,
            // reset the maximum value to zero.
            if (input.reset & self.enable_reset) == Bitvector::<1>::new(1) {
                next_max = Unsigned::<4>::new(0);
            }

            // Increment the free-running counter. It will wrap around eventually.
            let free_counter = state.free_counter + Unsigned::<4>::new(1);
            State {
                max_value: next_max,
                unused: input.unused,
                free_counter,
            }
        }

Trait Implementations

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

type Output = Unsigned<L>

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = Unsigned<L>

The resulting type after applying the & operator.

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

Performs the & operation.

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

type Output = Unsigned<L>

The resulting type after applying the | operator.

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

Performs the | operation.

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

type Output = Unsigned<L>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

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

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

Returns a copy 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>

type Output = Unsigned<L>

The resulting type after applying the / operator.

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

Performs the / operation.

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

type Output = Unsigned<X>

fn ext(self) -> Self::Output

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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>

type Output = Unsigned<L>

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = Unsigned<L>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

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>

type Output = Unsigned<L>

The resulting type after applying the % operator.

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

Performs the % operation.

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

type Output = Unsigned<L>

The resulting type after applying the << operator.

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

Performs the << operation.

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

type Output = Unsigned<L>

The resulting type after applying the >> operator.

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

Performs the >> operation.

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

type Output = Unsigned<L>

The resulting type after applying the - operator.

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

Performs the - operation.

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

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

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