Struct ux::i19

pub struct i19(_);

The 19-bit signed integer type.

Methods

impl i19

The 19-bit signed integer type.

const MAX: Self

MAX: Self = i19((1 as i32 << 19 - 1) - 1)

const MIN: Self

MIN: Self = i19(-(1 as i32 << 19 - 1))

impl i19

fn min_value() -> i19

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

fn max_value() -> i19

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

fn new(value: i32) -> i19

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<i8> for i19

fn from(x: i8) -> i19

Performs the conversion.

impl From<i16> for i19

fn from(x: i16) -> i19

Performs the conversion.

impl From<i2> for i19

fn from(x: i2) -> i19

Performs the conversion.

impl From<i3> for i19

fn from(x: i3) -> i19

Performs the conversion.

impl From<i4> for i19

fn from(x: i4) -> i19

Performs the conversion.

impl From<i5> for i19

fn from(x: i5) -> i19

Performs the conversion.

impl From<i6> for i19

fn from(x: i6) -> i19

Performs the conversion.

impl From<i7> for i19

fn from(x: i7) -> i19

Performs the conversion.

impl From<i9> for i19

fn from(x: i9) -> i19

Performs the conversion.

impl From<i10> for i19

fn from(x: i10) -> i19

Performs the conversion.

impl From<i11> for i19

fn from(x: i11) -> i19

Performs the conversion.

impl From<i12> for i19

fn from(x: i12) -> i19

Performs the conversion.

impl From<i13> for i19

fn from(x: i13) -> i19

Performs the conversion.

impl From<i14> for i19

fn from(x: i14) -> i19

Performs the conversion.

impl From<i15> for i19

fn from(x: i15) -> i19

Performs the conversion.

impl From<i17> for i19

fn from(x: i17) -> i19

Performs the conversion.

impl From<i18> for i19

fn from(x: i18) -> i19

Performs the conversion.

impl Default for i19

fn default() -> i19

Returns the "default value" for a type.

impl Clone for i19

fn clone(&self) -> i19

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for i19

impl Debug for i19

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

Formats the value using the given formatter.

impl PartialEq for i19

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 i19

impl PartialOrd for i19

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

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

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 i19

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

Formats the value using the given formatter.

impl UpperHex for i19

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

Formats the value using the given formatter.

impl LowerHex for i19

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

Formats the value using the given formatter.

impl Octal for i19

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

Formats the value using the given formatter.

impl Binary for i19

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

Formats the value using the given formatter.

impl<T> Shr<T> for i19 where
    i32: Shr<T, Output = i32>, 

type Output = i19

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl<T> Shl<T> for i19 where
    i32: Shl<T, Output = i32>, 

type Output = i19

The resulting type after applying the << operator.

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

Performs the << operation.

impl<T> ShrAssign<T> for i19 where
    i32: ShrAssign<T>, 

fn shr_assign(&mut self, rhs: T)

Performs the >>= operation.

impl<T> ShlAssign<T> for i19 where
    i32: ShlAssign<T>, 

fn shl_assign(&mut self, rhs: T)

Performs the <<= operation.

impl BitOr<i19> for i19

type Output = i19

The resulting type after applying the | operator.

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

Performs the | operation.

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

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

The resulting type after applying the | operator.

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

Performs the | operation.

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

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

The resulting type after applying the | operator.

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

Performs the | operation.

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

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

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign<i19> for i19

fn bitor_assign(&mut self, other: i19)

Performs the |= operation.