Struct u3

pub struct u3(/* private fields */);

The 3-bit unsigned integer type.

Implementations

impl u3

pub const MAX: Self

pub const MIN: Self

impl u3

pub const fn min_value() -> Self

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

pub const fn max_value() -> Self

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

pub fn new(value: u8) -> Self

pub const 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 num_x::*;

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 const 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 num_x::*;

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));

pub const fn capacity(self) -> u32

pub const fn rotate_left(self, n: u32) -> Self

pub const fn rotate_right(self, n: u32) -> Self

pub const fn count_ones(self) -> u32

pub const fn count_zeros(self) -> u32

pub const fn leading_zeros(self) -> u32

pub const fn trailing_zeros(self) -> u32

pub const fn reverse_bits(self) -> Self

pub const fn is_power_of_two(self) -> bool

Trait Implementations

impl Add for u3

type Output = u3

The resulting type after applying the + operator.

fn add(self, other: u3) -> Self::Output

Performs the + operation.

impl Binary for u3

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

Formats the value using the given formatter.

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

type Output = <u3 as BitOr>::Output

The resulting type after applying the & operator.

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

Performs the & operation.

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

type Output = <u3 as BitOr>::Output

The resulting type after applying the & operator.

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

Performs the & operation.

impl<'a> BitAnd for &'a u3

type Output = <u3 as BitOr>::Output

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAnd for u3

type Output = u3

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign for u3

fn bitand_assign(&mut self, other: Self)

Performs the &= operation.

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

type Output = <u3 as BitOr>::Output

The resulting type after applying the | operator.

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

Performs the | operation.

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

type Output = <u3 as BitOr>::Output

The resulting type after applying the | operator.

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

Performs the | operation.

impl<'a> BitOr for &'a u3

type Output = <u3 as BitOr>::Output

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr for u3

type Output = u3

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign for u3

fn bitor_assign(&mut self, other: Self)

Performs the |= operation.

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

type Output = <u3 as BitOr>::Output

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'a u3) -> Self::Output

Performs the ^ operation.

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

type Output = <u3 as BitOr>::Output

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: u3) -> Self::Output

Performs the ^ operation.

impl<'a> BitXor for &'a u3

type Output = <u3 as BitOr>::Output

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'a u3) -> Self::Output

Performs the ^ operation.

impl BitXor for u3

type Output = u3

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign for u3

fn bitxor_assign(&mut self, other: Self)

Performs the ^= operation.

impl Clone for u3

fn clone(&self) -> u3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for u3

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

Formats the value using the given formatter.

impl Default for u3

fn default() -> u3

Returns the “default value” for a type.

impl Display for u3

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

Formats the value using the given formatter.

impl From<u2> for u3

fn from(x: u2) -> u3

Converts to this type from the input type.

impl From<u3> for u10

fn from(x: u3) -> u10

Converts to this type from the input type.

impl From<u3> for u11

fn from(x: u3) -> u11

Converts to this type from the input type.

impl From<u3> for u12

fn from(x: u3) -> u12

Converts to this type from the input type.

impl From<u3> for u13

fn from(x: u3) -> u13

Converts to this type from the input type.

impl From<u3> for u14

fn from(x: u3) -> u14

Converts to this type from the input type.

impl From<u3> for u15

fn from(x: u3) -> u15

Converts to this type from the input type.

impl From<u3> for u16

fn from(x: u3) -> u16

Converts to this type from the input type.

impl From<u3> for u17

fn from(x: u3) -> u17

Converts to this type from the input type.

impl From<u3> for u18

fn from(x: u3) -> u18

Converts to this type from the input type.

impl From<u3> for u19

fn from(x: u3) -> u19

Converts to this type from the input type.

impl From<u3> for u20

fn from(x: u3) -> u20

Converts to this type from the input type.

impl From<u3> for u21

fn from(x: u3) -> u21

Converts to this type from the input type.

impl From<u3> for u22

fn from(x: u3) -> u22

Converts to this type from the input type.

impl From<u3> for u23

fn from(x: u3) -> u23

Converts to this type from the input type.

impl From<u3> for u24

fn from(x: u3) -> u24

Converts to this type from the input type.

impl From<u3> for u25

fn from(x: u3) -> u25

Converts to this type from the input type.

impl From<u3> for u26

fn from(x: u3) -> u26

Converts to this type from the input type.

impl From<u3> for u27

fn from(x: u3) -> u27

Converts to this type from the input type.

impl From<u3> for u28

fn from(x: u3) -> u28

Converts to this type from the input type.

impl From<u3> for u29

fn from(x: u3) -> u29

Converts to this type from the input type.

impl From<u3> for u30

fn from(x: u3) -> u30

Converts to this type from the input type.

impl From<u3> for u31

fn from(x: u3) -> u31

Converts to this type from the input type.

impl From<u3> for u32

fn from(x: u3) -> u32

Converts to this type from the input type.

impl From<u3> for u33

fn from(x: u3) -> u33

Converts to this type from the input type.

impl From<u3> for u34

fn from(x: u3) -> u34

Converts to this type from the input type.

impl From<u3> for u35

fn from(x: u3) -> u35

Converts to this type from the input type.

impl From<u3> for u36

fn from(x: u3) -> u36

Converts to this type from the input type.

impl From<u3> for u37

fn from(x: u3) -> u37

Converts to this type from the input type.

impl From<u3> for u38

fn from(x: u3) -> u38

Converts to this type from the input type.

impl From<u3> for u39

fn from(x: u3) -> u39

Converts to this type from the input type.

impl From<u3> for u4

fn from(x: u3) -> u4

Converts to this type from the input type.

impl From<u3> for u40

fn from(x: u3) -> u40

Converts to this type from the input type.

impl From<u3> for u41

fn from(x: u3) -> u41

Converts to this type from the input type.

impl From<u3> for u42

fn from(x: u3) -> u42

Converts to this type from the input type.

impl From<u3> for u43

fn from(x: u3) -> u43

Converts to this type from the input type.

impl From<u3> for u44

fn from(x: u3) -> u44

Converts to this type from the input type.

impl From<u3> for u45

fn from(x: u3) -> u45

Converts to this type from the input type.

impl From<u3> for u46

fn from(x: u3) -> u46

Converts to this type from the input type.

impl From<u3> for u47

fn from(x: u3) -> u47

Converts to this type from the input type.

impl From<u3> for u48

fn from(x: u3) -> u48

Converts to this type from the input type.

impl From<u3> for u49

fn from(x: u3) -> u49

Converts to this type from the input type.

impl From<u3> for u5

fn from(x: u3) -> u5

Converts to this type from the input type.

impl From<u3> for u50

fn from(x: u3) -> u50

Converts to this type from the input type.

impl From<u3> for u51

fn from(x: u3) -> u51

Converts to this type from the input type.

impl From<u3> for u52

fn from(x: u3) -> u52

Converts to this type from the input type.

impl From<u3> for u53

fn from(x: u3) -> u53

Converts to this type from the input type.

impl From<u3> for u54

fn from(x: u3) -> u54

Converts to this type from the input type.

impl From<u3> for u55

fn from(x: u3) -> u55

Converts to this type from the input type.

impl From<u3> for u56

fn from(x: u3) -> u56

Converts to this type from the input type.

impl From<u3> for u57

fn from(x: u3) -> u57

Converts to this type from the input type.

impl From<u3> for u58

fn from(x: u3) -> u58

Converts to this type from the input type.

impl From<u3> for u59

fn from(x: u3) -> u59

Converts to this type from the input type.

impl From<u3> for u6

fn from(x: u3) -> u6

Converts to this type from the input type.

impl From<u3> for u60

fn from(x: u3) -> u60

Converts to this type from the input type.

impl From<u3> for u61

fn from(x: u3) -> u61

Converts to this type from the input type.

impl From<u3> for u62

fn from(x: u3) -> u62

Converts to this type from the input type.

impl From<u3> for u63

fn from(x: u3) -> u63

Converts to this type from the input type.

impl From<u3> for u64

fn from(x: u3) -> u64

Converts to this type from the input type.

impl From<u3> for u7

fn from(x: u3) -> u7

Converts to this type from the input type.

impl From<u3> for u8

fn from(x: u3) -> u8

Converts to this type from the input type.

impl From<u3> for u9

fn from(x: u3) -> u9

Converts to this type from the input type.

impl From<u3> for usize

fn from(x: u3) -> usize

Converts to this type from the input type.

impl Hash for u3

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for u3

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

Formats the value using the given formatter.

impl<'a> Not for &'a u3

type Output = <u3 as Not>::Output

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Not for u3

type Output = u3

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Octal for u3

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

Formats the value using the given formatter.

impl Ord for u3

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 PartialEq for u3

fn eq(&self, other: &Self) -> 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 PartialOrd for u3

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<T> Shl<T> for u3

where u8: Shl<T, Output = u8>,

type Output = u3

The resulting type after applying the << operator.

fn shl(self, rhs: T) -> Self::Output

Performs the << operation.

impl<T> ShlAssign<T> for u3

where u8: ShlAssign<T>,

fn shl_assign(&mut self, rhs: T)

Performs the <<= operation.

impl<T> Shr<T> for u3

where u8: Shr<T, Output = u8>,

type Output = u3

The resulting type after applying the >> operator.

fn shr(self, rhs: T) -> Self::Output

Performs the >> operation.

impl<T> ShrAssign<T> for u3

where u8: ShrAssign<T>,

fn shr_assign(&mut self, rhs: T)

Performs the >>= operation.

impl Sub for u3

type Output = u3

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.

impl UpperHex for u3

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

Formats the value using the given formatter.

impl Copy for u3

impl Eq for u3