Struct ketos::integer::Integer

pub struct Integer(_);

Arbitrary precision signed integer

Methods

impl Integer

pub fn bits(&self) -> usize

Returns the number of bits required to represent the Integer.

pub fn from_bytes_be(sign: Sign, bytes: &[u8]) -> Integer

Creates an Integer from a sign and a series of big-endian bytes.

pub fn from_bytes_le(sign: Sign, bytes: &[u8]) -> Integer

Creates an Integer from a sign and a series of little-endian bytes.

pub fn from_f64(f: f64) -> Option<Integer>

Creates an Integer with the value of the given f64. Returns None if the value cannot be converted.

pub fn from_i8(i: i8) -> Integer

Creates an Integer with the value of the given i8.

pub fn from_i16(i: i16) -> Integer

Creates an Integer with the value of the given i16.

pub fn from_i32(i: i32) -> Integer

Creates an Integer with the value of the given i32.

pub fn from_i64(i: i64) -> Integer

Creates an Integer with the value of the given i64.

pub fn from_isize(i: isize) -> Integer

Creates an Integer with the value of the given isize.

pub fn from_u8(i: u8) -> Integer

Creates an Integer with the value of the given u8.

pub fn from_u16(i: u16) -> Integer

Creates an Integer with the value of the given u16.

pub fn from_u32(i: u32) -> Integer

Creates an Integer with the value of the given u32.

pub fn from_u64(i: u64) -> Integer

Creates an Integer with the value of the given u64.

pub fn from_usize(u: usize) -> Integer

Creates an Integer with the value of the given usize.

pub fn from_str_radix(s: &str, radix: u32) -> Result<Integer, FromStrRadixError>

Returns an Integer represented by a string in the given radix. radix must be in the range [2, 36].

pub fn to_bytes_be(&self) -> (Sign, Vec<u8>)

Returns integer sign and a series of big-endian bytes.

pub fn to_bytes_le(&self) -> (Sign, Vec<u8>)

Returns integer sign and a series of little-endian bytes.

pub fn to_str_radix(&self, radix: u32) -> String

Returns a string representation of the Integer in the given radix. radix must be in the range [2, 36].

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

Returns the Integer as an i8 value.

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

Returns the Integer as an i16 value.

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

Returns the Integer as an i32 value.

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

Returns the Integer as an i64 value.

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

Returns the Integer as an isize value.

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

Returns the Integer as an u8 value.

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

Returns the Integer as an u16 value.

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

Returns the Integer as an u32 value.

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

Returns the Integer as an u64 value.

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

Returns the Integer as an usize value.

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

Returns the Integer as an f32 value.

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

Returns the Integer as an f64 value.

pub fn pow(self, exp: usize) -> Integer

Raises the value to the power of exp.

pub fn abs(&self) -> Integer

Returns the absolute value of an Integer.

pub fn is_multiple_of(&self, rhs: &Integer) -> bool

Returns whether self is a multiple of rhs.

pub fn is_negative(&self) -> bool

Returns whether the Integer is less than zero.

pub fn is_positive(&self) -> bool

Returns whether the Integer is greater than zero.

pub fn is_zero(&self) -> bool

Returns whether the Integer is equal to zero.

pub fn zero() -> Integer

Returns an Integer of the value zero.

pub fn is_one(&self) -> bool

Returns whether the Integer is equal to one.

pub fn one() -> Integer

Returns an Integer of the value one.

Trait Implementations

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

type Output = Integer

The resulting type after applying the + operator.

fn add(self, rhs: &Integer) -> Integer

Performs the + operation.

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

type Output = Integer

The resulting type after applying the + operator.

fn add(self, rhs: &Integer) -> Integer

Performs the + operation.

impl Add<Integer> for Integer

type Output = Integer

The resulting type after applying the + operator.

fn add(self, rhs: Integer) -> Integer

Performs the + operation.

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

type Output = Integer

The resulting type after applying the + operator.

fn add(self, rhs: Integer) -> Integer

Performs the + operation.

impl<'a> AddAssign<&'a Integer> for Integer

fn add_assign(&mut self, rhs: &Integer)

Performs the += operation.

impl AddAssign<Integer> for Integer

fn add_assign(&mut self, rhs: Integer)

Performs the += operation.

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

type Output = Integer

The resulting type after applying the & operator.

fn bitand(self, rhs: &Integer) -> Integer

Performs the & operation.

impl<'a, 'b> BitAnd<&'b Integer> for &'a Integer

type Output = Integer

The resulting type after applying the & operator.

fn bitand(self, rhs: &Integer) -> Integer

Performs the & operation.

impl BitAnd<Integer> for Integer

type Output = Integer

The resulting type after applying the & operator.

fn bitand(self, rhs: Integer) -> Integer

Performs the & operation.

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

type Output = Integer

The resulting type after applying the & operator.

fn bitand(self, rhs: Integer) -> Integer

Performs the & operation.

impl<'a> BitAndAssign<&'a Integer> for Integer

fn bitand_assign(&mut self, rhs: &Integer)

Performs the &= operation.

impl BitAndAssign<Integer> for Integer

fn bitand_assign(&mut self, rhs: Integer)

Performs the &= operation.

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

type Output = Integer

The resulting type after applying the | operator.

fn bitor(self, rhs: &Integer) -> Integer

Performs the | operation.

impl<'a, 'b> BitOr<&'b Integer> for &'a Integer

type Output = Integer

The resulting type after applying the | operator.

fn bitor(self, rhs: &Integer) -> Integer

Performs the | operation.

impl BitOr<Integer> for Integer

type Output = Integer

The resulting type after applying the | operator.

fn bitor(self, rhs: Integer) -> Integer

Performs the | operation.

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

type Output = Integer

The resulting type after applying the | operator.

fn bitor(self, rhs: Integer) -> Integer

Performs the | operation.

impl<'a> BitOrAssign<&'a Integer> for Integer

fn bitor_assign(&mut self, rhs: &Integer)

Performs the |= operation.

impl BitOrAssign<Integer> for Integer

fn bitor_assign(&mut self, rhs: Integer)

Performs the |= operation.

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

type Output = Integer

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &Integer) -> Integer

Performs the ^ operation.

impl<'a, 'b> BitXor<&'b Integer> for &'a Integer

type Output = Integer

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &Integer) -> Integer

Performs the ^ operation.

impl BitXor<Integer> for Integer

type Output = Integer

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Integer) -> Integer

Performs the ^ operation.

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

type Output = Integer

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Integer) -> Integer

Performs the ^ operation.

impl<'a> BitXorAssign<&'a Integer> for Integer

fn bitxor_assign(&mut self, rhs: &Integer)

Performs the ^= operation.

impl BitXorAssign<Integer> for Integer

fn bitxor_assign(&mut self, rhs: Integer)

Performs the ^= operation.

impl Clone for Integer

fn clone(&self) -> Integer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Integer

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

Formats the value using the given formatter.

impl Default for Integer

fn default() -> Integer

Returns the "default value" for a type.

impl Display for Integer

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

Formats the value using the given formatter.

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

type Output = Integer

The resulting type after applying the / operator.

fn div(self, rhs: &Integer) -> Integer

Performs the / operation.

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

type Output = Integer

The resulting type after applying the / operator.

fn div(self, rhs: &Integer) -> Integer

Performs the / operation.

impl Div<Integer> for Integer

type Output = Integer

The resulting type after applying the / operator.

fn div(self, rhs: Integer) -> Integer

Performs the / operation.

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

type Output = Integer

The resulting type after applying the / operator.

fn div(self, rhs: Integer) -> Integer

Performs the / operation.

impl<'a> DivAssign<&'a Integer> for Integer

fn div_assign(&mut self, rhs: &Integer)

Performs the /= operation.

impl DivAssign<Integer> for Integer

fn div_assign(&mut self, rhs: Integer)

Performs the /= operation.

impl Eq for Integer

impl From<Integer> for Value

fn from(i: Integer) -> Value

Performs the conversion.

impl FromStr for Integer

type Err = FromStrIntError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Integer, FromStrIntError>

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

impl FromValue for Integer

fn from_value(v: Value) -> Result<Integer, ExecError>

Consumes the Value and returns a Rust value

impl<'a> FromValueRef<'a> for &'a Integer

fn from_value_ref(v: &'a Value) -> Result<&'a Integer, ExecError>

Returns the borrowed value

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

type Output = Integer

The resulting type after applying the * operator.

fn mul(self, rhs: &Integer) -> Integer

Performs the * operation.

impl<'a, 'b> Mul<&'b Integer> for &'a Integer

type Output = Integer

The resulting type after applying the * operator.

fn mul(self, rhs: &Integer) -> Integer

Performs the * operation.

impl Mul<Integer> for Integer

type Output = Integer

The resulting type after applying the * operator.

fn mul(self, rhs: Integer) -> Integer

Performs the * operation.

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

type Output = Integer

The resulting type after applying the * operator.

fn mul(self, rhs: Integer) -> Integer

Performs the * operation.

impl<'a> MulAssign<&'a Integer> for Integer

fn mul_assign(&mut self, rhs: &Integer)

Performs the *= operation.

impl MulAssign<Integer> for Integer

fn mul_assign(&mut self, rhs: Integer)

Performs the *= operation.

impl Neg for Integer

type Output = Integer

The resulting type after applying the - operator.

fn neg(self) -> Integer

Performs the unary - operation.

impl<'a> Neg for &'a Integer

type Output = Integer

The resulting type after applying the - operator.

fn neg(self) -> Integer

Performs the unary - operation.

impl Not for Integer

type Output = Integer

The resulting type after applying the ! operator.

fn not(self) -> Integer

Performs the unary ! operation.

impl<'a> Not for &'a Integer

type Output = Integer

The resulting type after applying the ! operator.

fn not(self) -> Integer

Performs the unary ! operation.

impl Ord for Integer

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

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Integer> for Integer

fn eq(&self, other: &Integer) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Integer) -> bool

This method tests for !=.

impl PartialEq<Integer> for Ratio

fn eq(&self, rhs: &Integer) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Ratio> for Integer

fn eq(&self, rhs: &Ratio) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Integer> for Integer

fn partial_cmp(&self, other: &Integer) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Integer) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Integer) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Integer) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Integer) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

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

type Output = Integer

The resulting type after applying the % operator.

fn rem(self, rhs: &Integer) -> Integer

Performs the % operation.

impl<'a, 'b> Rem<&'b Integer> for &'a Integer

type Output = Integer

The resulting type after applying the % operator.

fn rem(self, rhs: &Integer) -> Integer

Performs the % operation.

impl Rem<Integer> for Integer

type Output = Integer

The resulting type after applying the % operator.

fn rem(self, rhs: Integer) -> Integer

Performs the % operation.

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

type Output = Integer

The resulting type after applying the % operator.

fn rem(self, rhs: Integer) -> Integer

Performs the % operation.

impl<'a> RemAssign<&'a Integer> for Integer

fn rem_assign(&mut self, rhs: &Integer)

Performs the %= operation.

impl RemAssign<Integer> for Integer

fn rem_assign(&mut self, rhs: Integer)

Performs the %= operation.

impl Shl<usize> for Integer

type Output = Integer

The resulting type after applying the << operator.

fn shl(self, rhs: usize) -> Integer

Performs the << operation.

impl<'a> Shl<usize> for &'a Integer

type Output = Integer

The resulting type after applying the << operator.

fn shl(self, rhs: usize) -> Integer

Performs the << operation.

impl Shr<usize> for Integer

type Output = Integer

The resulting type after applying the >> operator.

fn shr(self, rhs: usize) -> Integer

Performs the >> operation.

impl<'a> Shr<usize> for &'a Integer

type Output = Integer

The resulting type after applying the >> operator.

fn shr(self, rhs: usize) -> Integer

Performs the >> operation.

impl StructuralEq for Integer

impl StructuralPartialEq for Integer

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

type Output = Integer

The resulting type after applying the - operator.

fn sub(self, rhs: &Integer) -> Integer

Performs the - operation.

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

type Output = Integer

The resulting type after applying the - operator.

fn sub(self, rhs: &Integer) -> Integer

Performs the - operation.

impl Sub<Integer> for Integer

type Output = Integer

The resulting type after applying the - operator.

fn sub(self, rhs: Integer) -> Integer

Performs the - operation.

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

type Output = Integer

The resulting type after applying the - operator.

fn sub(self, rhs: Integer) -> Integer

Performs the - operation.

impl<'a> SubAssign<&'a Integer> for Integer

fn sub_assign(&mut self, rhs: &Integer)

Performs the -= operation.

impl SubAssign<Integer> for Integer

fn sub_assign(&mut self, rhs: Integer)

Performs the -= operation.

impl Zero for Integer

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn zero() -> Integer

Returns the additive identity element of Self, 0. # Purity

fn set_zero(&mut self)

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