Struct ibig::IBig

pub struct IBig { /* fields omitted */ }

Signed big integer.

Arbitrarily large signed integer.

Examples

let a = ibig!(a2a123bbb127779cccc123123ccc base 32);
let b = ibig!(-0x1231abcd4134);
let c = IBig::from_str_radix("a2a123bbb127779cccc123123ccc", 32)?;
let d = IBig::from_str_radix("-1231abcd4134", 16)?;
assert_eq!(a, c);
assert_eq!(b, d);
Ok::<(), ParseError>(())

Implementations

impl IBig

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

Returns the number of trailing zeros in the two's complement binary representation.

In other words, it is the smallest n such that 2 to the power of n divides the number.

For 0, it returns None.

Examples

assert_eq!(ibig!(17).trailing_zeros(), Some(0));
assert_eq!(ibig!(-48).trailing_zeros(), Some(4));
assert_eq!(ibig!(-0b101000000).trailing_zeros(), Some(6));
assert_eq!(ibig!(0).trailing_zeros(), None);

impl IBig

pub fn in_radix(&self, radix: u32) -> InRadix<'_>

Representation in a given radix.

Panics

Panics radix is not between 2 and 36 inclusive.

Examples

assert_eq!(format!("{}", ibig!(100).in_radix(2)), "1100100");
assert_eq!(format!("{}", ibig!(-3000).in_radix(16)), "-bb8");
assert_eq!(format!("{:#}", ibig!(3000).in_radix(16)), "BB8");
assert_eq!(format!("{:+010}", ibig!(100).in_radix(2)), "+001100100");
assert_eq!(format!("{:=^10}", ibig!(-100).in_radix(2)), "=-1100100=");
// For bases 2, 8, 10, 16 we don't have to use `in_radix`:
assert_eq!(format!("{:x}", ibig!(-3000)), "-bb8");

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

String representation in an arbitrary radix.

Equivalent to self.to_radix(radix).to_string() but more efficient.

Panics

Panics radix is not between 2 and 36 inclusive.

Examples

assert_eq!(ibig!(-0x123f).to_str_radix(16), "-123f");

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

Upper-case string representation in an arbitrary radix.

Equivalent to format!("{:#}", self.in_radix(radix)) but more efficient.

Panics

Panics radix is not between 2 and 36 inclusive.

Examples

assert_eq!(ibig!(-0x123f).to_str_radix_uppercase(16), "-123F");

impl IBig

pub fn is_negative(&self) -> bool

Is the number smaller than 0?

Examples

assert_eq!(ibig!(-5).is_negative(), true);
assert_eq!(ibig!(0).is_negative(), false);
assert_eq!(ibig!(5).is_negative(), false);

pub fn is_positive(&self) -> bool

Is the number greater than 0?

Examples

assert_eq!(ibig!(-5).is_positive(), false);
assert_eq!(ibig!(0).is_positive(), false);
assert_eq!(ibig!(5).is_positive(), true);

impl IBig

pub fn from_str_radix(src: &str, radix: u32) -> Result<IBig, ParseError>

Convert a string in a given base to IBig.

The string may contain a + or - prefix. Digits 10-35 are represented by a-z or A-Z.

Panics

Panics if radix not in range 2-36.

Examples

assert_eq!(IBig::from_str_radix("-7ab", 32)?, ibig!(-7499));

pub fn from_str_with_radix_prefix(src: &str) -> Result<IBig, ParseError>

Convert a string with an optional radix prefix to IBig.

src may contain an '+' or - prefix..

Allowed prefixes: 0b for binary, 0o for octal, 0x for hexadecimal.

Examples

assert_eq!(IBig::from_str_with_radix_prefix("+0o17")?, ibig!(0o17));
assert_eq!(IBig::from_str_with_radix_prefix("-0x1f")?, ibig!(-0x1f));

Trait Implementations

impl Binary for IBig

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

Formats the value using the given formatter.

impl Debug for IBig

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

Formats the value using the given formatter.

impl Eq for IBig

impl<'_> From<&'_ UBig> for IBig

pub fn from(x: &UBig) -> IBig

Performs the conversion.

impl From<UBig> for IBig

pub fn from(x: UBig) -> IBig

Performs the conversion.

impl From<i128> for IBig

pub fn from(value: i128) -> IBig

Performs the conversion.

impl From<i16> for IBig

pub fn from(value: i16) -> IBig

Performs the conversion.

impl From<i32> for IBig

pub fn from(value: i32) -> IBig

Performs the conversion.

impl From<i64> for IBig

pub fn from(value: i64) -> IBig

Performs the conversion.

impl From<i8> for IBig

pub fn from(value: i8) -> IBig

Performs the conversion.

impl From<isize> for IBig

pub fn from(value: isize) -> IBig

Performs the conversion.

impl From<u128> for IBig

pub fn from(value: u128) -> IBig

Performs the conversion.

impl From<u16> for IBig

pub fn from(value: u16) -> IBig

Performs the conversion.

impl From<u32> for IBig

pub fn from(value: u32) -> IBig

Performs the conversion.

impl From<u64> for IBig

pub fn from(value: u64) -> IBig

Performs the conversion.

impl From<u8> for IBig

pub fn from(value: u8) -> IBig

Performs the conversion.

impl From<usize> for IBig

pub fn from(value: usize) -> IBig

Performs the conversion.

impl LowerHex for IBig

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

Formats the value using the given formatter.

impl Neg for IBig

type Output = IBig

The resulting type after applying the - operator.

pub fn neg(self) -> IBig

Performs the unary - operation.

impl<'_> Neg for &'_ IBig

type Output = IBig

The resulting type after applying the - operator.

pub fn neg(self) -> IBig

Performs the unary - operation.

impl Octal for IBig

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

Formats the value using the given formatter.

impl PartialEq<IBig> for IBig

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

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

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

This method tests for !=.

impl StructuralEq for IBig

impl StructuralPartialEq for IBig

impl<'_> TryFrom<&'_ IBig> for u8

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: &IBig) -> Result<u8, OutOfBoundsError>

Performs the conversion.

impl<'_> TryFrom<&'_ IBig> for u16

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: &IBig) -> Result<u16, OutOfBoundsError>

Performs the conversion.

impl<'_> TryFrom<&'_ IBig> for i128

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: &IBig) -> Result<i128, OutOfBoundsError>

Performs the conversion.

impl<'_> TryFrom<&'_ IBig> for isize

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: &IBig) -> Result<isize, OutOfBoundsError>

Performs the conversion.

impl<'_> TryFrom<&'_ IBig> for UBig

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(x: &IBig) -> Result<UBig, OutOfBoundsError>

Performs the conversion.

impl<'_> TryFrom<&'_ IBig> for u32

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: &IBig) -> Result<u32, OutOfBoundsError>

Performs the conversion.

impl<'_> TryFrom<&'_ IBig> for u64

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: &IBig) -> Result<u64, OutOfBoundsError>

Performs the conversion.

impl<'_> TryFrom<&'_ IBig> for u128

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: &IBig) -> Result<u128, OutOfBoundsError>

Performs the conversion.

impl<'_> TryFrom<&'_ IBig> for usize

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: &IBig) -> Result<usize, OutOfBoundsError>

Performs the conversion.

impl<'_> TryFrom<&'_ IBig> for i8

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: &IBig) -> Result<i8, OutOfBoundsError>

Performs the conversion.

impl<'_> TryFrom<&'_ IBig> for i16

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: &IBig) -> Result<i16, OutOfBoundsError>

Performs the conversion.

impl<'_> TryFrom<&'_ IBig> for i32

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: &IBig) -> Result<i32, OutOfBoundsError>

Performs the conversion.

impl<'_> TryFrom<&'_ IBig> for i64

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: &IBig) -> Result<i64, OutOfBoundsError>

Performs the conversion.

impl TryFrom<IBig> for u8

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: IBig) -> Result<u8, OutOfBoundsError>

Performs the conversion.

impl TryFrom<IBig> for u16

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: IBig) -> Result<u16, OutOfBoundsError>

Performs the conversion.

impl TryFrom<IBig> for i128

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: IBig) -> Result<i128, OutOfBoundsError>

Performs the conversion.

impl TryFrom<IBig> for isize

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: IBig) -> Result<isize, OutOfBoundsError>

Performs the conversion.

impl TryFrom<IBig> for UBig

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(x: IBig) -> Result<UBig, OutOfBoundsError>

Performs the conversion.

impl TryFrom<IBig> for u32

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: IBig) -> Result<u32, OutOfBoundsError>

Performs the conversion.

impl TryFrom<IBig> for u64

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: IBig) -> Result<u64, OutOfBoundsError>

Performs the conversion.

impl TryFrom<IBig> for u128

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: IBig) -> Result<u128, OutOfBoundsError>

Performs the conversion.

impl TryFrom<IBig> for usize

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: IBig) -> Result<usize, OutOfBoundsError>

Performs the conversion.

impl TryFrom<IBig> for i8

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: IBig) -> Result<i8, OutOfBoundsError>

Performs the conversion.

impl TryFrom<IBig> for i16

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: IBig) -> Result<i16, OutOfBoundsError>

Performs the conversion.

impl TryFrom<IBig> for i32

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: IBig) -> Result<i32, OutOfBoundsError>

Performs the conversion.

impl TryFrom<IBig> for i64

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: IBig) -> Result<i64, OutOfBoundsError>

Performs the conversion.

impl UpperHex for IBig

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

Formats the value using the given formatter.