Struct ux::u57

pub struct u57(_);

The 57-bit unsigned integer type.

Methods

impl u57

pub const MAX: Self

MAX: Self = u57(((1 as u64) << 57) - 1)

pub const MIN: Self

MIN: Self = u57(0)

impl u57

pub fn min_value() -> u57

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

pub fn max_value() -> u57

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

pub fn new(value: u64) -> u57

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

fn from(x: u8) -> u57

Performs the conversion.

impl From<u16> for u57

fn from(x: u16) -> u57

Performs the conversion.

impl From<u32> for u57

fn from(x: u32) -> u57

Performs the conversion.

impl From<u57> for u64

fn from(x: u57) -> u64

Performs the conversion.

impl From<u2> for u57

fn from(x: u2) -> u57

Performs the conversion.

impl From<u3> for u57

fn from(x: u3) -> u57

Performs the conversion.

impl From<u4> for u57

fn from(x: u4) -> u57

Performs the conversion.

impl From<u5> for u57

fn from(x: u5) -> u57

Performs the conversion.

impl From<u6> for u57

fn from(x: u6) -> u57

Performs the conversion.

impl From<u7> for u57

fn from(x: u7) -> u57

Performs the conversion.

impl From<u9> for u57

fn from(x: u9) -> u57

Performs the conversion.

impl From<u10> for u57

fn from(x: u10) -> u57

Performs the conversion.

impl From<u11> for u57

fn from(x: u11) -> u57

Performs the conversion.

impl From<u12> for u57

fn from(x: u12) -> u57

Performs the conversion.

impl From<u13> for u57

fn from(x: u13) -> u57

Performs the conversion.

impl From<u14> for u57

fn from(x: u14) -> u57

Performs the conversion.

impl From<u15> for u57

fn from(x: u15) -> u57

Performs the conversion.

impl From<u17> for u57

fn from(x: u17) -> u57

Performs the conversion.

impl From<u18> for u57

fn from(x: u18) -> u57

Performs the conversion.

impl From<u19> for u57

fn from(x: u19) -> u57

Performs the conversion.

impl From<u20> for u57

fn from(x: u20) -> u57

Performs the conversion.

impl From<u21> for u57

fn from(x: u21) -> u57

Performs the conversion.

impl From<u22> for u57

fn from(x: u22) -> u57

Performs the conversion.

impl From<u23> for u57

fn from(x: u23) -> u57

Performs the conversion.

impl From<u24> for u57

fn from(x: u24) -> u57

Performs the conversion.

impl From<u25> for u57

fn from(x: u25) -> u57

Performs the conversion.

impl From<u26> for u57

fn from(x: u26) -> u57

Performs the conversion.

impl From<u27> for u57

fn from(x: u27) -> u57

Performs the conversion.

impl From<u28> for u57

fn from(x: u28) -> u57

Performs the conversion.

impl From<u29> for u57

fn from(x: u29) -> u57

Performs the conversion.

impl From<u30> for u57

fn from(x: u30) -> u57

Performs the conversion.

impl From<u31> for u57

fn from(x: u31) -> u57

Performs the conversion.

impl From<u33> for u57

fn from(x: u33) -> u57

Performs the conversion.

impl From<u34> for u57

fn from(x: u34) -> u57

Performs the conversion.

impl From<u35> for u57

fn from(x: u35) -> u57

Performs the conversion.

impl From<u36> for u57

fn from(x: u36) -> u57

Performs the conversion.

impl From<u37> for u57

fn from(x: u37) -> u57

Performs the conversion.

impl From<u38> for u57

fn from(x: u38) -> u57

Performs the conversion.

impl From<u39> for u57

fn from(x: u39) -> u57

Performs the conversion.

impl From<u40> for u57

fn from(x: u40) -> u57

Performs the conversion.

impl From<u41> for u57

fn from(x: u41) -> u57

Performs the conversion.

impl From<u42> for u57

fn from(x: u42) -> u57

Performs the conversion.

impl From<u43> for u57

fn from(x: u43) -> u57

Performs the conversion.

impl From<u44> for u57

fn from(x: u44) -> u57

Performs the conversion.

impl From<u45> for u57

fn from(x: u45) -> u57

Performs the conversion.

impl From<u46> for u57

fn from(x: u46) -> u57

Performs the conversion.

impl From<u47> for u57

fn from(x: u47) -> u57

Performs the conversion.

impl From<u48> for u57

fn from(x: u48) -> u57

Performs the conversion.

impl From<u49> for u57

fn from(x: u49) -> u57

Performs the conversion.

impl From<u50> for u57

fn from(x: u50) -> u57

Performs the conversion.

impl From<u51> for u57

fn from(x: u51) -> u57

Performs the conversion.

impl From<u52> for u57

fn from(x: u52) -> u57

Performs the conversion.

impl From<u53> for u57

fn from(x: u53) -> u57

Performs the conversion.

impl From<u54> for u57

fn from(x: u54) -> u57

Performs the conversion.

impl From<u55> for u57

fn from(x: u55) -> u57

Performs the conversion.

impl From<u56> for u57

fn from(x: u56) -> u57

Performs the conversion.

impl From<u57> for u58

fn from(x: u57) -> u58

Performs the conversion.

impl From<u57> for u59

fn from(x: u57) -> u59

Performs the conversion.

impl From<u57> for u60

fn from(x: u57) -> u60

Performs the conversion.

impl From<u57> for u61

fn from(x: u57) -> u61

Performs the conversion.

impl From<u57> for u62

fn from(x: u57) -> u62

Performs the conversion.

impl From<u57> for u63

fn from(x: u57) -> u63

Performs the conversion.

impl Default for u57

fn default() -> u57

Returns the "default value" for a type.

impl Clone for u57

fn clone(&self) -> u57

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for u57

impl Debug for u57

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

Formats the value using the given formatter.

impl PartialEq for u57

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 u57

impl PartialOrd for u57

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

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

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 u57

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

Formats the value using the given formatter.

impl UpperHex for u57

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

Formats the value using the given formatter.

impl LowerHex for u57

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

Formats the value using the given formatter.

impl Octal for u57

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

Formats the value using the given formatter.

impl Binary for u57

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

Formats the value using the given formatter.

impl<T> Shr<T> for u57 where
    u64: Shr<T, Output = u64>, 

type Output = u57

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl<T> Shl<T> for u57 where
    u64: Shl<T, Output = u64>, 

type Output = u57

The resulting type after applying the << operator.

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

Performs the << operation.

impl<T> ShrAssign<T> for u57 where
    u64: ShrAssign<T>, 

fn shr_assign(&mut self, rhs: T)

Performs the >>= operation.

impl<T> ShlAssign<T> for u57 where
    u64: ShlAssign<T>, 

fn shl_assign(&mut self, rhs: T)

Performs the <<= operation.

impl BitOr<u57> for u57

type Output = u57

The resulting type after applying the | operator.

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

Performs the | operation.

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

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

The resulting type after applying the | operator.

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

Performs the | operation.

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

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

The resulting type after applying the | operator.

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

Performs the | operation.

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

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

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign<u57> for u57

fn bitor_assign(&mut self, other: u57)

Performs the |= operation.

impl BitXor<u57> for u57

type Output = u57

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

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

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

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

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

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

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

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

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

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign<u57> for u57

fn bitxor_assign(&mut self, other: u57)

Performs the ^= operation.

impl Not for u57

type Output = u57

The resulting type after applying the ! operator.

fn not(self) -> u57

Performs the unary ! operation.

impl<'a> Not for &'a u57

type Output = <u57 as Not>::Output

The resulting type after applying the ! operator.

fn not(self) -> u57

Performs the unary ! operation.

impl BitAnd<u57> for u57

type Output = u57

The resulting type after applying the & operator.

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

Performs the & operation.

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

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

The resulting type after applying the & operator.

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

Performs the & operation.

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

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

The resulting type after applying the & operator.

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

Performs the & operation.

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

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

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign<u57> for u57

fn bitand_assign(&mut self, other: u57)

Performs the &= operation.

impl Add<u57> for u57

type Output = u57

The resulting type after applying the + operator.

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

Performs the + operation.

impl Sub<u57> for u57

type Output = u57

The resulting type after applying the - operator.

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

Performs the - operation.