Struct i256

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

Signed 256-bit integer type.

This one of the physical representations of DecimalScalar values and can be safely converted back and forth with Arrow’s i256.

Implementations

impl i256

pub const ZERO: Self

pub const ONE: Self

pub const MAX: Self

pub const MIN: Self

pub const fn from_parts(lower: u128, upper: i128) -> Self

Construct a new i256 from an unsigned lower bits and a signed upper bits.

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

Create an i256 value from a signed 128-bit value.

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

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

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

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

Split the 256-bit signed integer value into an unsigned lower bits and a signed upper bits.

This versions gives us ownership of the value.

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

Split the 256-bit signed integer value into an unsigned lower bits and a signed upper bits.

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

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

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.

Trait Implementations

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 BigCast for i256

fn from<T: ToPrimitive>(n: T) -> Option<Self>

Cast the value n to Self using the relevant ToPrimitive method. If the value cannot be represented by Self, None is returned.

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 CheckedAdd for i256

fn checked_add(&self, v: &Self) -> Option<Self>

Adds two numbers, checking for overflow. If overflow happens, None is returned.

impl CheckedSub for i256

fn checked_sub(&self, v: &Self) -> Option<Self>

Subtracts two numbers, checking for underflow. If underflow happens, None is returned.

impl Clone for i256

fn clone(&self) -> i256

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConstZero for i256

const ZERO: Self

The additive identity element of Self, 0.

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 Div for i256

type Output = i256

The resulting type after applying the / operator.

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

Performs the / operation.

impl From<i256> for DecimalValue

fn from(value: i256) -> Self

Converts to this type from the input type.

impl From<i256> for i256

fn from(i: i256) -> Self

Converts to this type from the input type.

impl From<i256> for i256

fn from(i: i256) -> Self

Converts to this type from the input 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 Mul for i256

type Output = i256

The resulting type after applying the * operator.

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

Performs the * operation.

impl NativeDecimalType for i256

const VALUES_TYPE: DecimalValueType = DecimalValueType::I256

fn maybe_from(decimal_type: DecimalValue) -> Option<Self>

impl One for i256

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

where Self: PartialEq,

Returns true if self is equal to the multiplicative identity.

impl Ord for i256

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

type Output = i256

The resulting type after applying the % operator.

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

Performs the % operation.

impl Shl<usize> for i256

type Output = i256

The resulting type after applying the << operator.

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

Performs the << operation.

impl Shr for i256

type Output = i256

The resulting type after applying the >> operator.

fn shr(self, rhs: Self) -> 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 ToPrimitive for i256

fn to_i256(&self) -> Option<i256>

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

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_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_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_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_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_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_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 TryFrom<DecimalScalar<'_>> for i256

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: DecimalScalar<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl WrappingAdd for i256

fn wrapping_add(&self, v: &Self) -> Self

Wrapping (modular) addition. Computes self + other, wrapping around at the boundary of the type.

impl WrappingSub for i256

fn wrapping_sub(&self, v: &Self) -> Self

Wrapping (modular) subtraction. Computes self - other, wrapping around at the boundary of the type.

impl Zero for i256

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Copy for i256

impl Eq for i256

impl StructuralPartialEq for i256