Struct Tokens

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

Variable-length 120-bit integer. Used for native currencies.

Stored as 4 bits of len (0..=15), followed by len bytes.

Implementations

impl Tokens

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 MIN: Self

The smallest value that can be represented by this integer type.

pub const MAX: Self

The largest value that can be represented by this integer type.

pub const LEN_BITS: u16 = 4u16

The number of data bits that the length occupies.

pub const MAX_BITS: u16 = 124u16

The maximum number of data bits that this struct occupies.

pub const fn new(value: u128) -> Self

Creates a new integer value from a primitive integer.

pub const fn into_inner(self) -> u128

Converts integer into an underlying primitive integer.

pub const fn is_zero(&self) -> bool

Returns true if an underlying primitive integer is zero.

pub const fn is_valid(&self) -> bool

Returns true if an underlying primitive integer fits into the repr.

pub const fn bit_len(&self) -> Option<u16>

Returns number of data bits that this struct occupies. Returns None if an underlying primitive integer is too large.

pub const fn unwrap_bit_len(&self) -> u16

Returns number of data bits that this struct occupies. Returns MAX_BITS if an underlying primitive integer is too large.

pub const fn saturating_add(self, rhs: Self) -> Self

Saturating integer addition. Computes self + rhs, saturating at the numeric bounds instead of overflowing.

pub const fn saturating_sub(self, rhs: Self) -> Self

Saturating integer addition. Computes self - rhs, saturating at the numeric bounds instead of overflowing.

pub const fn saturating_mul(self, rhs: Self) -> Self

Saturating integer multiplication. Computes self * rhs, returning None if overflow occurred.

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

Checked integer addition. Computes self + rhs, returning None if overflow occurred.

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

Checked integer subtraction. Computes self - rhs, returning None if overflow occurred.

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

Checked integer multiplication. Computes self * rhs, returning None if overflow occurred.

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

Checked integer division. Computes self / rhs, returning None if rhs == 0 or overflow occurred.

pub fn try_add_assign(&mut self, other: Self) -> Result<(), Error>

Tries to add an other value to the current one.

pub fn try_sub_assign(&mut self, other: Self) -> Result<(), Error>

Tries to subtract an other value from the current one.

pub fn try_mul_assign(&mut self, other: Self) -> Result<(), Error>

Tries to multiply the current value by the other value.

pub fn try_div_assign(&mut self, other: Self) -> Result<(), Error>

Tries to divice the current value by the other value.

Trait Implementations

impl Add<u128> for Tokens

type Output = Tokens

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Tokens

type Output = Tokens

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<u128> for Tokens

fn add_assign(&mut self, rhs: u128)

Performs the += operation.

impl AddAssign for Tokens

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Binary for Tokens

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

Formats the value using the given formatter.

impl Clone for Tokens

fn clone(&self) -> Tokens

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tokens

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

Formats the value using the given formatter.

impl Default for Tokens

fn default() -> Tokens

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Tokens

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Tokens

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

Formats the value using the given formatter.

impl Div<u128> for Tokens

type Output = Tokens

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for Tokens

type Output = Tokens

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<u128> for Tokens

fn div_assign(&mut self, rhs: u128)

Performs the /= operation.

impl DivAssign for Tokens

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl ExactSize for Tokens

fn exact_size(&self) -> Size

Exact size of the value when it is stored in a slice.

impl From<Tokens> for BigInt

fn from(value: Tokens) -> Self

Converts to this type from the input type.

impl From<Tokens> for BigUint

fn from(value: Tokens) -> Self

Converts to this type from the input type.

impl From<Tokens> for CurrencyCollection

fn from(tokens: Tokens) -> Self

Converts to this type from the input type.

impl From<Tokens> for u128

fn from(value: Tokens) -> Self

Converts to this type from the input type.

impl FromAbi for Tokens

fn from_abi(value: AbiValue) -> Result<Self>

Constructs self from the ABI value.

impl FromStr for Tokens

type Err = ParseIntError

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 Tokens

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 IntoAbi for Tokens

fn as_abi(&self) -> AbiValue

Returns a corresponding ABI value.

fn into_abi(self) -> AbiValue

where Self: Sized,

Converts into a corresponding ABI value.

impl<'a> Load<'a> for Tokens

fn load_from(slice: &mut CellSlice<'a>) -> Result<Self, Error>

Tries to load itself from a cell slice.

impl LowerHex for Tokens

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

Formats the value using the given formatter.

impl Mul<u128> for Tokens

type Output = Tokens

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Tokens

type Output = Tokens

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<u128> for Tokens

fn mul_assign(&mut self, rhs: u128)

Performs the *= operation.

impl MulAssign for Tokens

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Ord for Tokens

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

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

Tests for self and other values to be equal, and is used by ==.

const 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 PartialEq<u128> for Tokens

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

Tests for self and other values to be equal, and is used by ==.

const 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 PartialEq for Tokens

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

Tests for self and other values to be equal, and is used by ==.

const 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 Tokens

fn partial_cmp(&self, other: &Tokens) -> 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 Serialize for Tokens

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Shl<u8> for Tokens

type Output = Tokens

The resulting type after applying the << operator.

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

Performs the << operation.

impl ShlAssign<u8> for Tokens

fn shl_assign(&mut self, rhs: u8)

Performs the <<= operation.

impl Shr<u8> for Tokens

type Output = Tokens

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl ShrAssign<u8> for Tokens

fn shr_assign(&mut self, rhs: u8)

Performs the >>= operation.

impl Store for Tokens

fn store_into( &self, builder: &mut CellBuilder, _: &dyn CellContext, ) -> Result<(), Error>

Tries to store itself into the cell builder.

impl Sub<u128> for Tokens

type Output = Tokens

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Tokens

type Output = Tokens

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<u128> for Tokens

fn sub_assign(&mut self, rhs: u128)

Performs the -= operation.

impl SubAssign for Tokens

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl TryFrom<u128> for Tokens

type Error = ParseIntError

The type returned in the event of a conversion error.

fn try_from(inner: u128) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperHex for Tokens

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

Formats the value using the given formatter.

impl WithAbiType for Tokens

fn abi_type() -> AbiType

Returns a corresponding ABI type.

impl Copy for Tokens

impl Eq for Tokens

impl StructuralPartialEq for Tokens