Struct ibig::UBig

pub struct UBig(_);

Unsigned big integer.

Arbitrarily large unsigned integer.

Examples

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

Implementations

impl UBig

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

Returns the number of trailing zeros in the 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!(ubig!(17).trailing_zeros(), Some(0));
assert_eq!(ubig!(48).trailing_zeros(), Some(4));
assert_eq!(ubig!(0b101000000).trailing_zeros(), Some(6));
assert_eq!(ubig!(0).trailing_zeros(), None);

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

Integer logarithm base 2.

Returns the floor of the logarithm base 2 of the number. In other words, it is the position of the highest 1 bit in the binary representation.

For 0, it returns None.

Examples

assert_eq!(ubig!(17).ilog2(), Some(4));
assert_eq!(ubig!(0b101000000).ilog2(), Some(8));
assert_eq!(ubig!(0).ilog2(), None);

impl UBig

pub fn from_le_bytes(bytes: &[u8]) -> UBig

Construct from little-endian bytes.

Examples

assert_eq!(UBig::from_le_bytes(&[3, 2, 1]), ubig!(0x010203));

pub fn from_be_bytes(bytes: &[u8]) -> UBig

Construct from big-endian bytes.

Examples

assert_eq!(UBig::from_be_bytes(&[1, 2, 3]), ubig!(0x010203));

pub fn to_le_bytes(&self) -> Vec<u8>

Return little-endian bytes.

Examples

assert!(ubig!(0).to_le_bytes().is_empty());
assert_eq!(ubig!(0x010203).to_le_bytes(), [3, 2, 1]);

pub fn to_be_bytes(&self) -> Vec<u8>

Return big-endian bytes.

Examples

assert!(ubig!(0).to_be_bytes().is_empty());
assert_eq!(ubig!(0x010203).to_be_bytes(), [1, 2, 3]);

impl UBig

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!("{}", ubig!(100).in_radix(2)), "1100100");
assert_eq!(format!("{}", ubig!(3000).in_radix(16)), "bb8");
assert_eq!(format!("{:#}", ubig!(3000).in_radix(16)), "BB8");
assert_eq!(format!("{:+010}", ubig!(100).in_radix(2)), "+001100100");
assert_eq!(format!("{:=^10}", ubig!(100).in_radix(2)), "=1100100==");
// For bases 2, 8, 10, 16 we don't have to use `in_radix`:
assert_eq!(format!("{:x}", ubig!(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!(ubig!(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!(ubig!(0x123f).to_str_radix_uppercase(16), "123F");

impl UBig

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

Convert a string in a given base to UBig.

src may contain an optional + prefix. Digits 10-35 are represented by a-z or A-Z.

Panics

Panics if radix not in range 2-36.

Examples

assert_eq!(UBig::from_str_radix("+7ab", 32)?, ubig!(7499));

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

Convert a string with an optional radix prefix to UBig.

src may contain an optional + prefix.

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

Examples

assert_eq!(UBig::from_str_with_radix_prefix("+0o17")?, ubig!(0o17));
assert_eq!(UBig::from_str_with_radix_prefix("0x1f")?, ubig!(0x1f));

Trait Implementations

impl Binary for UBig

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

Formats the value using the given formatter.

impl Clone for UBig

pub fn clone(&self) -> UBig

Returns a copy of the value.

pub fn clone_from(&mut self, source: &UBig)

Performs copy-assignment from source.

impl Debug for UBig

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

Formats the value using the given formatter.

impl Eq for UBig

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<bool> for UBig

pub fn from(b: bool) -> UBig

Performs the conversion.

impl From<u128> for UBig

pub fn from(value: u128) -> UBig

Performs the conversion.

impl From<u16> for UBig

pub fn from(value: u16) -> UBig

Performs the conversion.

impl From<u32> for UBig

pub fn from(value: u32) -> UBig

Performs the conversion.

impl From<u64> for UBig

pub fn from(value: u64) -> UBig

Performs the conversion.

impl From<u8> for UBig

pub fn from(value: u8) -> UBig

Performs the conversion.

impl From<usize> for UBig

pub fn from(value: usize) -> UBig

Performs the conversion.

impl LowerHex for UBig

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

Formats the value using the given formatter.

impl Octal for UBig

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

Formats the value using the given formatter.

impl PartialEq<UBig> for UBig

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

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

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

This method tests for !=.

impl StructuralEq for UBig

impl StructuralPartialEq for UBig

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<&'_ UBig> for u8

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

pub fn try_from(value: &UBig) -> Result<i64, 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<UBig> for u8

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<UBig> for u16

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<UBig> for i128

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<UBig> for isize

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<UBig> for u32

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<UBig> for u64

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<UBig> for u128

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<UBig> for usize

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<UBig> for i8

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<UBig> for i16

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<UBig> for i32

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<UBig> for i64

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<i128> for UBig

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<i16> for UBig

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<i32> for UBig

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<i64> for UBig

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<i8> for UBig

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<isize> for UBig

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl UpperHex for UBig

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

Formats the value using the given formatter.