Struct concordium_contracts_common::Amount

#[repr(transparent)]
pub struct Amount {
    pub micro_ccd: u64,
}

The type of amounts on the chain

Fields

micro_ccd: u64

Implementations

impl Amount

pub const fn from_micro_ccd(micro_ccd: u64) -> Amount

Create amount from a number of microCCD

pub const fn micro_ccd(&self) -> u64

Get the amount in microCCD

pub const fn from_ccd(ccd: u64) -> Amount

Create amount from a number of CCD

pub const fn zero() -> Amount

Create zero amount

pub fn add_micro_ccd(self, micro_ccd: u64) -> Amount

Add a number of micro CCD to an amount

pub fn checked_add(self, other: Amount) -> Option<Amount>

Checked addition. Adds another amount and returns None if overflow occurred.

pub fn checked_sub(self, other: Amount) -> Option<Amount>

Checked subtraction. Subtracts another amount and returns None if underflow occurred.

pub fn add_ccd(self, ccd: u64) -> Amount

Add a number of CCD to an amount

pub fn subtract_micro_ccd(self, micro_ccd: u64) -> Amount

Subtract a number of micro CCD to an amount

pub fn subtract_ccd(self, ccd: u64) -> Amount

Subtract a number of CCD to an amount

pub fn quotient_remainder(self, denominator: u64) -> (Amount, Amount)

Calculates the quotient and remainder of integer division

Trait Implementations

impl Add for Amount

type Output = Amount

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Amount

fn add_assign(&mut self, other: Amount)

Performs the += operation.

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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deserial for Amount

fn deserial<R: Read>(source: &mut R) -> ParseResult<Self>

Attempt to read a structure from a given source, failing if an error occurs during deserialization or reading.

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

fn deserialize<D: Deserializer<'de>>(des: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Amount

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

Formats the value using the given formatter.

impl FromStr for Amount

Parse from string in CCD units. The input string must be of the form n[.m] where n and m are both digits. The notation [.m] indicates that that part is optional.

• if n starts with 0 then it must be 0l
• m can have at most 6 digits, and must have at least 1
• both n and m must be non-negative.

type Err = AmountParseError

The associated error which can be returned from parsing.

fn from_str(v: &str) -> Result<Self, Self::Err>

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

impl Hash for Amount

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 Mul<Amount> for u64

type Output = Amount

The resulting type after applying the * operator.

fn mul(self, other: Amount) -> Self::Output

Performs the * operation.

impl Mul<u64> for Amount

type Output = Amount

The resulting type after applying the * operator.

fn mul(self, other: u64) -> Self::Output

Performs the * operation.

impl MulAssign<u64> for Amount

fn mul_assign(&mut self, other: u64)

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 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 Rem<u64> for Amount

type Output = Amount

The resulting type after applying the % operator.

fn rem(self, other: u64) -> Self::Output

Performs the % operation.

impl RemAssign<u64> for Amount

fn rem_assign(&mut self, other: u64)

Performs the %= operation.

impl SchemaType for Amount

fn get_type() -> Type

impl Serial for Amount

fn serial<W: Write>(&self, out: &mut W) -> Result<(), W::Err>

Attempt to write the structure into the provided writer, failing if only part of the structure could be written.

impl Serialize for Amount

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

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) -> Self::Output

Performs the - operation.

impl SubAssign for Amount

fn sub_assign(&mut self, other: Amount)

Performs the -= operation.

impl Sum for Amount

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

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

impl Copy for Amount

impl Eq for Amount

impl StructuralPartialEq for Amount