Struct i256

#[repr(C)]
pub struct i256 {
    low: u128,
    high: i128,
}

A signed 256-bit integer

Fields

low: u128

high: i128

Implementations

impl i256

pub const ZERO: Self = _

The additive identity for this integer type, i.e. 0.

pub const ONE: Self = _

The multiplicative identity for this integer type, i.e. 1.

pub const MINUS_ONE: Self = _

The multiplicative inverse for this integer type, i.e. -1.

pub const MAX: Self = _

The maximum value that can be represented by this integer type

pub const MIN: Self = _

The minimum value that can be represented by this integer type

pub const fn from_le_bytes(b: [u8; 32]) -> Self

Create an integer value from its representation as a byte array in little-endian.

pub const fn from_be_bytes(b: [u8; 32]) -> Self

Create an integer value from its representation as a byte array in big-endian.

pub const fn from_i128(v: i128) -> Self

Create an i256 value from a 128-bit value.

pub fn from_string(value_str: &str) -> Option<Self>

Create an integer value from its representation as string.

pub fn from_f64(v: f64) -> Option<Self>

Create an optional i256 from the provided f64. Returning None if overflow occurred

pub const fn from_parts(low: u128, high: i128) -> Self

Create an i256 from the provided low u128 and high i128

pub const fn to_parts(self) -> (u128, i128)

Returns this i256 as a low u128 and high i128

pub fn to_i128(self) -> Option<i128>

Converts this i256 into an i128 returning None if this would result in truncation/overflow

pub fn as_i128(self) -> i128

Wraps this i256 into an i128

pub const fn to_le_bytes(self) -> [u8; 32]

Return the memory representation of this integer as a byte array in little-endian byte order.

pub const fn to_be_bytes(self) -> [u8; 32]

Return the memory representation of this integer as a byte array in big-endian byte order.

fn from_bigint_with_overflow(v: BigInt) -> (Self, bool)

Create an i256 from the provided BigInt returning a bool indicating if overflow occurred

pub fn wrapping_abs(self) -> Self

Computes the absolute value of this i256

pub fn checked_abs(self) -> Option<Self>

Computes the absolute value of this i256 returning None if Self == Self::MIN

pub fn wrapping_neg(self) -> Self

Negates this i256

pub fn checked_neg(self) -> Option<Self>

Negates this i256 returning None if Self == Self::MIN

pub fn wrapping_add(self, other: Self) -> Self

Performs wrapping addition

pub fn checked_add(self, other: Self) -> Option<Self>

Performs checked addition

pub fn wrapping_sub(self, other: Self) -> Self

Performs wrapping subtraction

pub fn checked_sub(self, other: Self) -> Option<Self>

Performs checked subtraction

pub fn wrapping_mul(self, other: Self) -> Self

Performs wrapping multiplication

pub fn checked_mul(self, other: Self) -> Option<Self>

Performs checked multiplication

fn div_rem(self, other: Self) -> Result<(Self, Self), DivRemError>

Division operation, returns (quotient, remainder). This basically implements [Long division]: <https://en.wikipedia.org/wiki/Division_algorithm>

fn as_digits(self) -> [u64; 4]

Interpret this i256 as 4 u64 digits, least significant first

fn from_digits(digits: [u64; 4]) -> Self

Interpret 4 u64 digits, least significant first, as a i256

pub fn wrapping_div(self, other: Self) -> Self

Performs wrapping division

pub fn checked_div(self, other: Self) -> Option<Self>

Performs checked division

pub fn wrapping_rem(self, other: Self) -> Self

Performs wrapping remainder

pub fn checked_rem(self, other: Self) -> Option<Self>

Performs checked remainder

pub fn checked_pow(self, exp: u32) -> Option<Self>

Performs checked exponentiation

pub fn wrapping_pow(self, exp: u32) -> Self

Performs wrapping exponentiation

pub const fn signum(self) -> Self

Returns a number i256 representing sign of this i256.

0 if the number is zero 1 if the number is positive -1 if the number is negative

pub const fn is_negative(self) -> bool

Returns true if this i256 is negative

pub const fn is_positive(self) -> bool

Returns true if this i256 is positive

Trait Implementations

impl<'a, 'b> Add<&'b i256> for &'a i256

type Output = i256

The resulting type after applying the + operator.

fn add(self, rhs: &'b i256) -> Self::Output

Performs the + operation.

impl<'a> Add<&'a i256> for i256

type Output = i256

The resulting type after applying the + operator.

fn add(self, rhs: &'a i256) -> Self::Output

Performs the + operation.

impl<'a> Add<i256> for &'a i256

type Output = i256

The resulting type after applying the + operator.

fn add(self, rhs: i256) -> Self::Output

Performs the + operation.

impl Add for i256

type Output = i256

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for i256

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl ArrowNativeType for i256

fn from_usize(u: usize) -> Option<Self>

Convert native integer type from usize

fn as_usize(self) -> usize

Convert to usize according to the as operator

fn usize_as(i: usize) -> Self

Convert from usize according to the as operator

fn to_usize(self) -> Option<usize>

Convert native type to usize.

fn to_isize(self) -> Option<isize>

Convert native type to isize.

fn to_i64(self) -> Option<i64>

Convert native type to i64.

fn get_byte_width() -> usize

Returns the byte width of this native type.

fn from_i32(_: i32) -> Option<Self>

👎Deprecated: please use Option::Some instead

Convert native type from i32.

fn from_i64(_: i64) -> Option<Self>

👎Deprecated: please use Option::Some instead

Convert native type from i64.

fn from_i128(_: i128) -> Option<Self>

👎Deprecated: please use Option::Some instead

Convert native type from i128.

impl AsPrimitive<i256> for i16

fn as_(self) -> i256

Convert a value to another, using the as operator.

impl AsPrimitive<i256> for i32

fn as_(self) -> i256

Convert a value to another, using the as operator.

impl AsPrimitive<i256> for i64

fn as_(self) -> i256

Convert a value to another, using the as operator.

impl AsPrimitive<i256> for i8

fn as_(self) -> i256

Convert a value to another, using the as operator.

impl AsPrimitive<i256> for u16

fn as_(self) -> i256

Convert a value to another, using the as operator.

impl AsPrimitive<i256> for u32

fn as_(self) -> i256

Convert a value to another, using the as operator.

impl AsPrimitive<i256> for u64

fn as_(self) -> i256

Convert a value to another, using the as operator.

impl AsPrimitive<i256> for u8

fn as_(self) -> i256

Convert a value to another, using the as operator.

impl BitAnd for i256

type Output = i256

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitOr for i256

type Output = i256

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitXor for i256

type Output = i256

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl Clone for i256

fn clone(&self) -> i256

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for i256

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

Formats the value using the given formatter.

impl Default for i256

fn default() -> i256

Returns the “default value” for a type.

impl Display for i256

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

Formats the value using the given formatter.

impl<'a, 'b> Div<&'b i256> for &'a i256

type Output = i256

The resulting type after applying the / operator.

fn div(self, rhs: &'b i256) -> Self::Output

Performs the / operation.

impl<'a> Div<&'a i256> for i256

type Output = i256

The resulting type after applying the / operator.

fn div(self, rhs: &'a i256) -> Self::Output

Performs the / operation.

impl<'a> Div<i256> for &'a i256

type Output = i256

The resulting type after applying the / operator.

fn div(self, rhs: i256) -> Self::Output

Performs the / operation.

impl Div for i256

type Output = i256

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign for i256

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<i16> for i256

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for i256

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for i256

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<i8> for i256

fn from(value: i8) -> Self

Converts to this type from the input type.

impl FromStr for i256

type Err = ParseI256Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for i256

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<'a, 'b> Mul<&'b i256> for &'a i256

type Output = i256

The resulting type after applying the * operator.

fn mul(self, rhs: &'b i256) -> Self::Output

Performs the * operation.

impl<'a> Mul<&'a i256> for i256

type Output = i256

The resulting type after applying the * operator.

fn mul(self, rhs: &'a i256) -> Self::Output

Performs the * operation.

impl<'a> Mul<i256> for &'a i256

type Output = i256

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for i256

type Output = i256

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for i256

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for i256

type Output = i256

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for i256

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 i256

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

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<'a, 'b> Rem<&'b i256> for &'a i256

type Output = i256

The resulting type after applying the % operator.

fn rem(self, rhs: &'b i256) -> Self::Output

Performs the % operation.

impl<'a> Rem<&'a i256> for i256

type Output = i256

The resulting type after applying the % operator.

fn rem(self, rhs: &'a i256) -> Self::Output

Performs the % operation.

impl<'a> Rem<i256> for &'a i256

type Output = i256

The resulting type after applying the % operator.

fn rem(self, rhs: i256) -> Self::Output

Performs the % operation.

impl Rem for i256

type Output = i256

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign for i256

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl Shl<u8> for i256

type Output = i256

The resulting type after applying the << operator.

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

Performs the << operation.

impl Shr<u8> for i256

type Output = i256

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl<'a, 'b> Sub<&'b i256> for &'a i256

type Output = i256

The resulting type after applying the - operator.

fn sub(self, rhs: &'b i256) -> Self::Output

Performs the - operation.

impl<'a> Sub<&'a i256> for i256

type Output = i256

The resulting type after applying the - operator.

fn sub(self, rhs: &'a i256) -> Self::Output

Performs the - operation.

impl<'a> Sub<i256> for &'a i256

type Output = i256

The resulting type after applying the - operator.

fn sub(self, rhs: i256) -> Self::Output

Performs the - operation.

impl Sub for i256

type Output = i256

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for i256

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl ToPrimitive for i256

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.

impl Copy for i256

impl Eq for i256

impl Sealed for i256

impl StructuralPartialEq for i256