Struct linera_sdk::linera_base_types::Amount

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

A non-negative amount of tokens.

This is a fixed-point fraction, with Amount::DECIMAL_PLACES digits after the point. Amount::ONE is one whole token, divisible into 10.pow(Amount::DECIMAL_PLACES) parts.

Implementations

impl Amount

pub const ZERO: Amount = _

The zero value.

pub const MAX: Amount = _

The maximum value.

pub fn try_add(self, other: Amount) -> Result<Amount, ArithmeticError>

Checked addition.

pub fn try_add_one(self) -> Result<Amount, ArithmeticError>

Checked increment.

pub fn saturating_add(self, other: Amount) -> Amount

Saturating addition.

pub fn try_sub(self, other: Amount) -> Result<Amount, ArithmeticError>

Checked subtraction.

pub fn try_sub_one(self) -> Result<Amount, ArithmeticError>

Checked decrement.

pub fn saturating_sub(self, other: Amount) -> Amount

Saturating subtraction.

pub fn try_add_assign(&mut self, other: Amount) -> Result<(), ArithmeticError>

Checked in-place addition.

pub fn try_add_assign_one(&mut self) -> Result<(), ArithmeticError>

Checked in-place increment.

pub fn saturating_add_assign(&mut self, other: Amount)

Saturating in-place addition.

pub fn try_sub_assign(&mut self, other: Amount) -> Result<(), ArithmeticError>

Checked in-place subtraction.

pub fn saturating_mul(&self, other: u128) -> Amount

Saturating multiplication.

pub fn try_mul(self, other: u128) -> Result<Amount, ArithmeticError>

Checked multiplication.

pub fn try_mul_assign(&mut self, other: u128) -> Result<(), ArithmeticError>

Checked in-place multiplication.

impl Amount

pub const DECIMAL_PLACES: u8 = 18u8

The base-10 exponent representing how much a token can be divided.

pub const ONE: Amount = _

One token.

pub fn from_tokens(tokens: u128) -> Amount

Returns an Amount corresponding to that many tokens, or Amount::MAX if saturated.

pub fn from_millis(millitokens: u128) -> Amount

Returns an Amount corresponding to that many millitokens, or Amount::MAX if saturated.

pub fn from_micros(microtokens: u128) -> Amount

Returns an Amount corresponding to that many microtokens, or Amount::MAX if saturated.

pub fn from_nanos(nanotokens: u128) -> Amount

Returns an Amount corresponding to that many nanotokens, or Amount::MAX if saturated.

pub fn from_attos(attotokens: u128) -> Amount

Returns an Amount corresponding to that many attotokens.

pub fn upper_half(self) -> u64

Helper function to obtain the 64 most significant bits of the balance.

pub fn lower_half(self) -> u64

Helper function to obtain the 64 least significant bits of the balance.

pub fn saturating_div(self, other: Amount) -> u128

Divides this by the other amount. If the other is 0, it returns u128::MAX.

pub fn is_zero(&self) -> bool

Returns whether this amount is 0.

Trait Implementations

impl Add for Amount

type Output = Amount

The resulting type after applying the + operator.

fn add(self, other: Amount) -> Amount

Performs the + operation.

impl Arbitrary for Amount

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<Amount>

The type of Strategy used to generate values of type Self.

fn arbitrary_with( args: <Amount as Arbitrary>::Parameters, ) -> <Amount as Arbitrary>::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for Amount

fn clone(&self) -> Amount

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Amount

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

Formats the value using the given formatter.

impl Default for Amount

fn default() -> Amount

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Amount

fn deserialize<D>( deserializer: D, ) -> Result<Amount, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Amount

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

Formats the value using the given formatter.

impl From<u128> for Amount

fn from(value: u128) -> Amount

Converts to this type from the input type.

impl FromStr for Amount

type Err = ParseAmountError

The associated error which can be returned from parsing.

fn from_str(src: &str) -> Result<Amount, <Amount as FromStr>::Err>

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

impl Hash for Amount

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 InputType for Amount

type RawValueType = Amount

The raw type used for validator.

fn type_name() -> Cow<'static, str>

Type the name.

fn create_type_info(registry: &mut Registry) -> String

Create type information in the registry and return qualified typename.

fn parse(value: Option<ConstValue>) -> Result<Amount, InputValueError<Amount>>

Parse from Value. None represents undefined.

fn to_value(&self) -> ConstValue

Convert to a Value for introspection.

fn as_raw_value(&self) -> Option<&<Amount as InputType>::RawValueType>

Returns a reference to the raw value.

fn qualified_type_name() -> String

Qualified typename.

impl Mul<u128> for Amount

type Output = Amount

The resulting type after applying the * operator.

fn mul(self, other: u128) -> Amount

Performs the * operation.

impl Ord for Amount

fn cmp(&self, other: &Amount) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl OutputType for Amount

fn type_name() -> Cow<'static, str>

Type the name.

fn create_type_info(registry: &mut Registry) -> String

Create type information in the registry and return qualified typename.

async fn resolve( &self, _: &ContextBase<'_, &Positioned<SelectionSet>>, _field: &Positioned<Field>, ) -> Result<ConstValue, ServerError>

Resolve an output value to async_graphql::Value.

fn qualified_type_name() -> String

Qualified typename.

fn introspection_type_name(&self) -> Cow<'static, str>

Introspection type name

impl PartialEq for Amount

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Amount

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

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

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

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

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

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

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

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

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

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

impl ScalarType for Amount

fn parse(value: ConstValue) -> Result<Amount, InputValueError<Amount>>

Parse a scalar value.

fn to_value(&self) -> ConstValue

Convert the scalar to Value.

fn is_valid(_value: &ConstValue) -> bool

Checks for a valid scalar value.

impl Serialize for Amount

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Amount

type Output = Amount

The resulting type after applying the - operator.

fn sub(self, other: Amount) -> Amount

Performs the - operation.

impl<'a> Sum<&'a Amount> for Amount

fn sum<I>(iter: I) -> Amount

where I: Iterator<Item = &'a Amount>,

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl WitLoad for Amount

fn load<Instance>( memory: &Memory<'_, Instance>, location: GuestPointer, ) -> Result<Amount, RuntimeError>

where Instance: InstanceWithMemory, <<Instance as Instance>::Runtime as Runtime>::Memory: RuntimeMemory<Instance>,

Loads an instance of the type from the location in the guest’s memory.

fn lift_from<Instance>( flat_layout: <<Amount as WitType>::Layout as Layout>::Flat, memory: &Memory<'_, Instance>, ) -> Result<Amount, RuntimeError>

where Instance: InstanceWithMemory, <<Instance as Instance>::Runtime as Runtime>::Memory: RuntimeMemory<Instance>,

Lifts an instance of the type from the flat_layout representation.

impl WitStore for Amount

fn store<Instance>( &self, memory: &mut Memory<'_, Instance>, location: GuestPointer, ) -> Result<(), RuntimeError>

where Instance: InstanceWithMemory, <<Instance as Instance>::Runtime as Runtime>::Memory: RuntimeMemory<Instance>,

Stores the type at the location in the guest’s memory.

fn lower<Instance>( &self, memory: &mut Memory<'_, Instance>, ) -> Result<<<Amount as WitType>::Layout as Layout>::Flat, RuntimeError>

where Instance: InstanceWithMemory, <<Instance as Instance>::Runtime as Runtime>::Memory: RuntimeMemory<Instance>,

Lowers the type into its flat layout representation.

impl WitType for Amount

const SIZE: u32 = 16u32

The size of the type when laid out in memory.

type Layout = <HCons<u128, HNil> as WitType>::Layout

The layout of the type as fundamental types.

type Dependencies = HCons<u128, HNil>

Other WitTypes that this type depends on.

fn wit_type_name() -> Cow<'static, str>

Generates the WIT type name for this type.

fn wit_type_declaration() -> Cow<'static, str>

Generates the WIT type declaration for this type.

impl Copy for Amount

impl Eq for Amount

impl StructuralPartialEq for Amount