Struct lv2rs::prelude::u4

pub struct u4(_);

The 4-bit unsigned integer type.

Methods

impl u4

pub const MAX: u4

pub const MIN: u4

impl u4

pub fn min_value() -> u4

Returns the smallest value that can be represented by this integer type.

pub fn max_value() -> u4

Returns the largest value that can be represented by this integer type.

pub fn new(value: u8) -> u4

Crates a new variable

This function mainly exists as there is currently not a better way to construct these types. May be deprecated or removed if a better way to construct these types becomes available.

Examples

Basic usage:

use ux::*;

assert_eq!(u31::new(64), u31::from(64u8));

Panic

This function will panic if value is not representable by this type

pub fn wrapping_sub(self, rhs: u4) -> u4

Wrapping (modular) subtraction. Computes self - other, wrapping around at the boundary of the type.

Examples

Basic usage:

use ux::*;

assert_eq!(i5::MIN.wrapping_sub(i5::new(1)), i5::MAX);

assert_eq!(i5::new(-10).wrapping_sub(i5::new(5)), i5::new(-15));
assert_eq!(i5::new(-15).wrapping_sub(i5::new(5)), i5::new(12));

pub fn wrapping_add(self, rhs: u4) -> u4

Wrapping (modular) addition. Computes self + other, wrapping around at the boundary of the type.

Examples

Basic usage:

use ux::*;

assert_eq!(i5::MAX.wrapping_add(i5::new(1)), i5::MIN);

assert_eq!(i5::new(10).wrapping_add(i5::new(5)), i5::new(15));
assert_eq!(i5::new(15).wrapping_add(i5::new(5)), i5::new(-12));

Trait Implementations

impl Copy for u4

impl Ord for u4

fn cmp(&self, other: &u4) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Clone for u4

fn clone(&self) -> u4

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> BitAnd<&'a u4> for u4

type Output = <u4 as BitOr<u4>>::Output

The resulting type after applying the & operator.

fn bitand(self, rhs: &'a u4) -> <u4 as BitAnd<&'a u4>>::Output

Performs the & operation.

impl<'a> BitAnd<&'a u4> for &'a u4

type Output = <u4 as BitOr<u4>>::Output

The resulting type after applying the & operator.

fn bitand(self, rhs: &'a u4) -> <&'a u4 as BitAnd<&'a u4>>::Output

Performs the & operation.

impl<'a> BitAnd<u4> for &'a u4

type Output = <u4 as BitOr<u4>>::Output

The resulting type after applying the & operator.

fn bitand(self, rhs: u4) -> <&'a u4 as BitAnd<u4>>::Output

Performs the & operation.

impl BitAnd<u4> for u4

type Output = u4

The resulting type after applying the & operator.

fn bitand(self, rhs: u4) -> <u4 as BitAnd<u4>>::Output

Performs the & operation.

impl BitOrAssign<u4> for u4

fn bitor_assign(&mut self, other: u4)

Performs the |= operation.

impl<T> ShrAssign<T> for u4 where
    u8: ShrAssign<T>, 

fn shr_assign(&mut self, rhs: T)

Performs the >>= operation.

impl BitAndAssign<u4> for u4

fn bitand_assign(&mut self, other: u4)

Performs the &= operation.

impl Binary for u4

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

Formats the value using the given formatter.

impl Hash for u4

fn hash<H>(&self, h: &mut H) where
    H: Hasher, 

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Add<u4> for u4

type Output = u4

The resulting type after applying the + operator.

fn add(self, other: u4) -> u4

Performs the + operation.

impl UpperHex for u4

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

Formats the value using the given formatter.

impl<'a> BitOr<u4> for &'a u4

type Output = <u4 as BitOr<u4>>::Output

The resulting type after applying the | operator.

fn bitor(self, rhs: u4) -> <&'a u4 as BitOr<u4>>::Output

Performs the | operation.

impl<'a> BitOr<&'a u4> for &'a u4

type Output = <u4 as BitOr<u4>>::Output

The resulting type after applying the | operator.

fn bitor(self, rhs: &'a u4) -> <&'a u4 as BitOr<&'a u4>>::Output

Performs the | operation.

impl<'a> BitOr<&'a u4> for u4

type Output = <u4 as BitOr<u4>>::Output

The resulting type after applying the | operator.

fn bitor(self, rhs: &'a u4) -> <u4 as BitOr<&'a u4>>::Output

Performs the | operation.

impl BitOr<u4> for u4

type Output = u4

The resulting type after applying the | operator.

fn bitor(self, rhs: u4) -> <u4 as BitOr<u4>>::Output

Performs the | operation.

impl From<u2> for u4

fn from(x: u2) -> u4

Performs the conversion.

impl From<u4> for u14

fn from(x: u4) -> u14

Performs the conversion.

impl From<u4> for u7

fn from(x: u4) -> u7

Performs the conversion.

impl From<u3> for u4

fn from(x: u3) -> u4

Performs the conversion.

impl PartialOrd<u4> for u4

fn partial_cmp(&self, other: &u4) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for u4

impl Debug for u4

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

Formats the value using the given formatter.

impl Sub<u4> for u4

type Output = u4

The resulting type after applying the - operator.

fn sub(self, other: u4) -> u4

Performs the - operation.

impl<'a> BitXor<&'a u4> for u4

type Output = <u4 as BitOr<u4>>::Output

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'a u4) -> <u4 as BitXor<&'a u4>>::Output

Performs the ^ operation.

impl BitXor<u4> for u4

type Output = u4

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: u4) -> <u4 as BitXor<u4>>::Output

Performs the ^ operation.

impl<'a> BitXor<u4> for &'a u4

type Output = <u4 as BitOr<u4>>::Output

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: u4) -> <&'a u4 as BitXor<u4>>::Output

Performs the ^ operation.

impl<'a> BitXor<&'a u4> for &'a u4

type Output = <u4 as BitOr<u4>>::Output

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'a u4) -> <&'a u4 as BitXor<&'a u4>>::Output

Performs the ^ operation.

impl Default for u4

fn default() -> u4

Returns the "default value" for a type.

impl<T> Shr<T> for u4 where
    u8: Shr<T>,
    <u8 as Shr<T>>::Output == u8, 

type Output = u4

The resulting type after applying the >> operator.

fn shr(self, rhs: T) -> u4

Performs the >> operation.

impl Octal for u4

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

Formats the value using the given formatter.

impl PartialEq<u4> for u4

fn eq(&self, other: &u4) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T> ShlAssign<T> for u4 where
    u8: ShlAssign<T>, 

fn shl_assign(&mut self, rhs: T)

Performs the <<= operation.

impl<'a> Not for &'a u4

type Output = <u4 as Not>::Output

The resulting type after applying the ! operator.

fn not(self) -> u4

Performs the unary ! operation.

impl Not for u4

type Output = u4

The resulting type after applying the ! operator.

fn not(self) -> u4

Performs the unary ! operation.

impl<T> Shl<T> for u4 where
    u8: Shl<T>,
    <u8 as Shl<T>>::Output == u8, 

type Output = u4

The resulting type after applying the << operator.

fn shl(self, rhs: T) -> u4

Performs the << operation.

impl Display for u4

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

Formats the value using the given formatter.

impl BitXorAssign<u4> for u4

fn bitxor_assign(&mut self, other: u4)

Performs the ^= operation.

impl LowerHex for u4

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

Formats the value using the given formatter.