Struct ux::u2

pub struct u2(_);

The 2-bit unsigned integer type.

Methods

impl u2

pub const MAX: Self

MAX: Self = u2(((1 as u8) << 2) - 1)

pub const MIN: Self

MIN: Self = u2(0)

impl u2

pub fn min_value() -> u2

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

pub fn max_value() -> u2

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

pub fn new(value: u8) -> u2

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: Self) -> Self

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: Self) -> Self

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 From<u2> for u8

fn from(x: u2) -> u8

Performs the conversion.

impl From<u2> for u16

fn from(x: u2) -> u16

Performs the conversion.

impl From<u2> for u32

fn from(x: u2) -> u32

Performs the conversion.

impl From<u2> for u64

fn from(x: u2) -> u64

Performs the conversion.

impl From<u2> for u3

fn from(x: u2) -> u3

Performs the conversion.

impl From<u2> for u4

fn from(x: u2) -> u4

Performs the conversion.

impl From<u2> for u5

fn from(x: u2) -> u5

Performs the conversion.

impl From<u2> for u6

fn from(x: u2) -> u6

Performs the conversion.

impl From<u2> for u7

fn from(x: u2) -> u7

Performs the conversion.

impl From<u2> for u9

fn from(x: u2) -> u9

Performs the conversion.

impl From<u2> for u10

fn from(x: u2) -> u10

Performs the conversion.

impl From<u2> for u11

fn from(x: u2) -> u11

Performs the conversion.

impl From<u2> for u12

fn from(x: u2) -> u12

Performs the conversion.

impl From<u2> for u13

fn from(x: u2) -> u13

Performs the conversion.

impl From<u2> for u14

fn from(x: u2) -> u14

Performs the conversion.

impl From<u2> for u15

fn from(x: u2) -> u15

Performs the conversion.

impl From<u2> for u17

fn from(x: u2) -> u17

Performs the conversion.

impl From<u2> for u18

fn from(x: u2) -> u18

Performs the conversion.

impl From<u2> for u19

fn from(x: u2) -> u19

Performs the conversion.

impl From<u2> for u20

fn from(x: u2) -> u20

Performs the conversion.

impl From<u2> for u21

fn from(x: u2) -> u21

Performs the conversion.

impl From<u2> for u22

fn from(x: u2) -> u22

Performs the conversion.

impl From<u2> for u23

fn from(x: u2) -> u23

Performs the conversion.

impl From<u2> for u24

fn from(x: u2) -> u24

Performs the conversion.

impl From<u2> for u25

fn from(x: u2) -> u25

Performs the conversion.

impl From<u2> for u26

fn from(x: u2) -> u26

Performs the conversion.

impl From<u2> for u27

fn from(x: u2) -> u27

Performs the conversion.

impl From<u2> for u28

fn from(x: u2) -> u28

Performs the conversion.

impl From<u2> for u29

fn from(x: u2) -> u29

Performs the conversion.

impl From<u2> for u30

fn from(x: u2) -> u30

Performs the conversion.

impl From<u2> for u31

fn from(x: u2) -> u31

Performs the conversion.

impl From<u2> for u33

fn from(x: u2) -> u33

Performs the conversion.

impl From<u2> for u34

fn from(x: u2) -> u34

Performs the conversion.

impl From<u2> for u35

fn from(x: u2) -> u35

Performs the conversion.

impl From<u2> for u36

fn from(x: u2) -> u36

Performs the conversion.

impl From<u2> for u37

fn from(x: u2) -> u37

Performs the conversion.

impl From<u2> for u38

fn from(x: u2) -> u38

Performs the conversion.

impl From<u2> for u39

fn from(x: u2) -> u39

Performs the conversion.

impl From<u2> for u40

fn from(x: u2) -> u40

Performs the conversion.

impl From<u2> for u41

fn from(x: u2) -> u41

Performs the conversion.

impl From<u2> for u42

fn from(x: u2) -> u42

Performs the conversion.

impl From<u2> for u43

fn from(x: u2) -> u43

Performs the conversion.

impl From<u2> for u44

fn from(x: u2) -> u44

Performs the conversion.

impl From<u2> for u45

fn from(x: u2) -> u45

Performs the conversion.

impl From<u2> for u46

fn from(x: u2) -> u46

Performs the conversion.

impl From<u2> for u47

fn from(x: u2) -> u47

Performs the conversion.

impl From<u2> for u48

fn from(x: u2) -> u48

Performs the conversion.

impl From<u2> for u49

fn from(x: u2) -> u49

Performs the conversion.

impl From<u2> for u50

fn from(x: u2) -> u50

Performs the conversion.

impl From<u2> for u51

fn from(x: u2) -> u51

Performs the conversion.

impl From<u2> for u52

fn from(x: u2) -> u52

Performs the conversion.

impl From<u2> for u53

fn from(x: u2) -> u53

Performs the conversion.

impl From<u2> for u54

fn from(x: u2) -> u54

Performs the conversion.

impl From<u2> for u55

fn from(x: u2) -> u55

Performs the conversion.

impl From<u2> for u56

fn from(x: u2) -> u56

Performs the conversion.

impl From<u2> for u57

fn from(x: u2) -> u57

Performs the conversion.

impl From<u2> for u58

fn from(x: u2) -> u58

Performs the conversion.

impl From<u2> for u59

fn from(x: u2) -> u59

Performs the conversion.

impl From<u2> for u60

fn from(x: u2) -> u60

Performs the conversion.

impl From<u2> for u61

fn from(x: u2) -> u61

Performs the conversion.

impl From<u2> for u62

fn from(x: u2) -> u62

Performs the conversion.

impl From<u2> for u63

fn from(x: u2) -> u63

Performs the conversion.

impl Default for u2

fn default() -> u2

Returns the "default value" for a type.

impl Clone for u2

fn clone(&self) -> u2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for u2

impl Debug for u2

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PartialEq for u2

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

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

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

This method tests for !=.

impl Eq for u2

impl PartialOrd for u2

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

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

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

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

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

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

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

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

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 Ord for u2

fn cmp(&self, other: &u2) -> 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.

impl Hash for u2

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

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 Display for u2

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

Formats the value using the given formatter.

impl UpperHex for u2

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

Formats the value using the given formatter.

impl LowerHex for u2

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

Formats the value using the given formatter.

impl Octal for u2

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

Formats the value using the given formatter.

impl Binary for u2

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

Formats the value using the given formatter.

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

type Output = u2

The resulting type after applying the >> operator.

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

Performs the >> operation.

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

type Output = u2

The resulting type after applying the << operator.

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

Performs the << operation.

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

fn shr_assign(&mut self, rhs: T)

Performs the >>= operation.

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

fn shl_assign(&mut self, rhs: T)

Performs the <<= operation.

impl BitOr<u2> for u2

type Output = u2

The resulting type after applying the | operator.

fn bitor(self, rhs: u2) -> Self::Output

Performs the | operation.

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

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

The resulting type after applying the | operator.

fn bitor(self, rhs: &'a u2) -> Self::Output

Performs the | operation.

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

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

The resulting type after applying the | operator.

fn bitor(self, rhs: u2) -> Self::Output

Performs the | operation.

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

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

The resulting type after applying the | operator.

fn bitor(self, rhs: &'a u2) -> Self::Output

Performs the | operation.

impl BitOrAssign<u2> for u2

fn bitor_assign(&mut self, other: u2)

Performs the |= operation.

impl BitAnd<u2> for u2

type Output = u2

The resulting type after applying the & operator.

fn bitand(self, rhs: u2) -> Self::Output

Performs the & operation.

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

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

The resulting type after applying the & operator.

fn bitand(self, rhs: &'a u2) -> Self::Output

Performs the & operation.

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

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

The resulting type after applying the & operator.

fn bitand(self, rhs: u2) -> Self::Output

Performs the & operation.

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

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

The resulting type after applying the & operator.

fn bitand(self, rhs: &'a u2) -> Self::Output

Performs the & operation.

impl BitAndAssign<u2> for u2

fn bitand_assign(&mut self, other: u2)

Performs the &= operation.

impl Add<u2> for u2

type Output = u2

The resulting type after applying the + operator.

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

Performs the + operation.

impl Sub<u2> for u2

type Output = u2

The resulting type after applying the - operator.

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

Performs the - operation.