Struct i126 

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

The 126-bit signed integer type.

Implementations

impl i126

The 126-bit signed integer type.

pub const MAX: Self

pub const MIN: Self

pub const BITS: u32 = 126u32

impl i126

pub fn min_value() -> i126

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

pub fn max_value() -> i126

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

pub const fn new(value: i128) -> i126

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 nsw_types::*;

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 nsw_types::*;

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 nsw_types::*;

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 Add for i126

type Output = i126

The resulting type after applying the + operator.

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

Performs the + operation.

impl Binary for i126

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

Formats the value using the given formatter.

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

type Output = <i126 as BitOr>::Output

The resulting type after applying the & operator.

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

Performs the & operation.

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

type Output = <i126 as BitOr>::Output

The resulting type after applying the & operator.

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

Performs the & operation.

impl<'a> BitAnd for &'a i126

type Output = <i126 as BitOr>::Output

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAnd for i126

type Output = i126

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign for i126

fn bitand_assign(&mut self, other: i126)

Performs the &= operation.

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

type Output = <i126 as BitOr>::Output

The resulting type after applying the | operator.

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

Performs the | operation.

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

type Output = <i126 as BitOr>::Output

The resulting type after applying the | operator.

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

Performs the | operation.

impl<'a> BitOr for &'a i126

type Output = <i126 as BitOr>::Output

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr for i126

type Output = i126

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign for i126

fn bitor_assign(&mut self, other: i126)

Performs the |= operation.

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

type Output = <i126 as BitOr>::Output

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

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

type Output = <i126 as BitOr>::Output

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<'a> BitXor for &'a i126

type Output = <i126 as BitOr>::Output

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXor for i126

type Output = i126

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign for i126

fn bitxor_assign(&mut self, other: i126)

Performs the ^= operation.

impl Clone for i126

fn clone(&self) -> i126

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for i126

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

Formats the value using the given formatter.

impl Default for i126

fn default() -> i126

Returns the “default value” for a type.

impl Display for i126

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

Formats the value using the given formatter.

impl Hash for i126

fn hash<__H: Hasher>(&self, state: &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 i126

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

Formats the value using the given formatter.

impl Mul for i126

type Output = i126

The resulting type after applying the * operator.

fn mul(self, rhs: i126) -> Self::Output

Performs the * operation.

impl<'a> Not for &'a i126

type Output = <i126 as Not>::Output

The resulting type after applying the ! operator.

fn not(self) -> i126

Performs the unary ! operation.

impl Not for i126

type Output = i126

The resulting type after applying the ! operator.

fn not(self) -> i126

Performs the unary ! operation.

impl Octal for i126

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

Formats the value using the given formatter.

impl Ord for i126

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

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

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

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

type Output = i126

The resulting type after applying the << operator.

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

Performs the << operation.

impl<T> ShlAssign<T> for i126

where i128: ShlAssign<T>,

fn shl_assign(&mut self, rhs: T)

Performs the <<= operation.

impl<T> Shr<T> for i126

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

type Output = i126

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl<T> ShrAssign<T> for i126

where i128: ShrAssign<T>,

fn shr_assign(&mut self, rhs: T)

Performs the >>= operation.

impl Sub for i126

type Output = i126

The resulting type after applying the - operator.

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

Performs the - operation.

impl UpperHex for i126

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

Formats the value using the given formatter.

impl Copy for i126

impl Eq for i126

impl StructuralPartialEq for i126