Struct ux::u17

pub struct u17(_);

The 17-bit unsigned integer type.

Methods

impl u17

const MAX: Self

MAX: Self = u17((1 as u32 << 17) - 1)

const MIN: Self

MIN: Self = u17(0)

impl u17

fn min_value() -> u17

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

fn max_value() -> u17

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

fn new(value: u32) -> u17

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

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

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<u8> for u17

fn from(x: u8) -> u17

Performs the conversion.

impl From<u16> for u17

fn from(x: u16) -> u17

Performs the conversion.

impl From<u2> for u17

fn from(x: u2) -> u17

Performs the conversion.

impl From<u3> for u17

fn from(x: u3) -> u17

Performs the conversion.

impl From<u4> for u17

fn from(x: u4) -> u17

Performs the conversion.

impl From<u5> for u17

fn from(x: u5) -> u17

Performs the conversion.

impl From<u6> for u17

fn from(x: u6) -> u17

Performs the conversion.

impl From<u7> for u17

fn from(x: u7) -> u17

Performs the conversion.

impl From<u9> for u17

fn from(x: u9) -> u17

Performs the conversion.

impl From<u10> for u17

fn from(x: u10) -> u17

Performs the conversion.

impl From<u11> for u17

fn from(x: u11) -> u17

Performs the conversion.

impl From<u12> for u17

fn from(x: u12) -> u17

Performs the conversion.

impl From<u13> for u17

fn from(x: u13) -> u17

Performs the conversion.

impl From<u14> for u17

fn from(x: u14) -> u17

Performs the conversion.

impl From<u15> for u17

fn from(x: u15) -> u17

Performs the conversion.

impl Default for u17

fn default() -> u17

Returns the "default value" for a type.

impl Clone for u17

fn clone(&self) -> u17

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for u17

impl Debug for u17

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

Formats the value using the given formatter.

impl PartialEq for u17

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 u17

impl PartialOrd for u17

fn partial_cmp(&self, other: &u17) -> 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 u17

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

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 u17

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

Formats the value using the given formatter.

impl UpperHex for u17

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

Formats the value using the given formatter.

impl LowerHex for u17

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

Formats the value using the given formatter.

impl Octal for u17

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

Formats the value using the given formatter.

impl Binary for u17

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

Formats the value using the given formatter.

impl<T> Shr<T> for u17 where
    u32: Shr<T, Output = u32>, 

type Output = u17

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl<T> Shl<T> for u17 where
    u32: Shl<T, Output = u32>, 

type Output = u17

The resulting type after applying the << operator.

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

Performs the << operation.

impl<T> ShrAssign<T> for u17 where
    u32: ShrAssign<T>, 

fn shr_assign(&mut self, rhs: T)

Performs the >>= operation.

impl<T> ShlAssign<T> for u17 where
    u32: ShlAssign<T>, 

fn shl_assign(&mut self, rhs: T)

Performs the <<= operation.

impl BitOr<u17> for u17

type Output = u17

The resulting type after applying the | operator.

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

Performs the | operation.

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

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

The resulting type after applying the | operator.

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

Performs the | operation.

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

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

The resulting type after applying the | operator.

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

Performs the | operation.

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

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

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign<u17> for u17

fn bitor_assign(&mut self, other: u17)

Performs the |= operation.