Struct Asset 

pub struct Asset {
    pub amount: i64,
    pub symbol: Symbol,
}

The Asset struct represents a asset

Reference: https://github.com/AntelopeIO/cdt/blob/main/libraries/eosiolib/core/eosio/asset.hpp

Examples

use antelope::{Asset, Symbol};

let quantity = Asset::from_amount(10000, Symbol::from("4,FOO"));
assert_eq!(10000, quantity.amount);

Fields

amount: i64

symbol: Symbol

Implementations

impl Asset

pub const MAX_AMOUNT: i64 = 4_611_686_018_427_387_903i64

pub fn new() -> Self

pub fn from_amount(amount: i64, symbol: Symbol) -> Self

pub fn is_amount_within_range(&self) -> bool

Check if the amount doesn’t exceed the max amount

@return true - if the amount doesn’t exceed the max amount @return false - otherwise

pub fn is_valid(&self) -> bool

Check if the asset is valid. %A valid asset has its amount <= max_amount and its symbol name valid

@return true - if the asset is valid @return false - otherwise

pub fn set_amount(self, amount: i64)

Set the amount of the asset

@param a - New amount for the asset

pub fn value(&self) -> f64

@return float value of amount

Trait Implementations

impl Add for Asset

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

Addition operator

@param other - The second asset to be added to the first asset @return asset - New asset as the result of addition

type Output = Asset

The resulting type after applying the + operator.

impl AddAssign for Asset

fn add_assign(&mut self, a: Self)

Addition Assignment operator

@param a - Another asset to add with this asset @post The amount of this asset is added with the amount of asset a

impl AsRef<Asset> for Asset

fn as_ref(&self) -> &Asset

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Asset

fn clone(&self) -> Asset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Asset

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

Formats the value using the given formatter.

impl Default for Asset

fn default() -> Asset

Returns the “default value” for a type.

impl Display for Asset

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

Converts the asset into string

@return String in the form of “1.2345 SYM” format, where SYM symbol has precision equal to 4

impl Div<i64> for Asset

fn div(self, b: i64) -> Asset

Division operator, with a number proceeding

@param a - The asset to be divided @param b - The divisor for the asset’s amount @return asset - New asset as the result of division

type Output = Asset

The resulting type after applying the / operator.

impl Div for Asset

fn div(self, b: Asset) -> Self::Output

Division operator, with another asset

@param a - The asset which amount acts as the dividend @param b - The asset which amount acts as the divisor @return int64_t - the resulted amount after the division @pre Both asset must have the same symbol

type Output = i64

The resulting type after applying the / operator.

impl DivAssign<i64> for Asset

fn div_assign(&mut self, a: i64)

Division assignment operator, with a number proceeding

@brief Division assignment operator, with a number proceeding @param self - The asset to be divided @param a - The divisor for the asset’s amount @return asset - Reference to the asset, which has been divided

impl From<&str> for Asset

fn from(s: &str) -> Self

Parse Asset from string formatted as “1.2345 SYM@contract”

impl FromStr for Asset

type Err = ParseError

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 Mul<Asset> for i64

fn mul(self, a: Asset) -> Asset

Multiplication operator, with a number preceeding

@param a - The multiplier for the asset’s amount @param b - The asset to be multiplied @return asset - New asset as the result of multiplication

type Output = Asset

The resulting type after applying the * operator.

impl Mul<i64> for Asset

fn mul(self, b: i64) -> Asset

Multiplication operator, with a number proceeding

@brief Multiplication operator, with a number proceeding @param a - The asset to be multiplied @param b - The multiplier for the asset’s amount @return asset - New asset as the result of multiplication

type Output = Asset

The resulting type after applying the * operator.

impl MulAssign<i64> for Asset

fn mul_assign(&mut self, a: i64)

Multiplication assignment operator, with a number

@details Multiplication assignment operator. Multiply the amount of this asset with a number and then assign the value to itself. @param a - The multiplier for the asset’s amount @return asset - Reference to this asset @post The amount of this asset is multiplied by a

impl Neg for Asset

fn neg(self) -> Asset

Negate the amount of the asset

@return a new asset with the negated amount

type Output = Asset

The resulting type after applying the - operator.

impl Ord for Asset

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

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

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

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 Asset

fn partial_cmp(&self, other: &Self) -> 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 Sub for Asset

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

Subtraction operator

@param other - The asset used to subtract from the first asset @return asset - New asset as the result of subtraction

type Output = Asset

The resulting type after applying the - operator.

impl SubAssign for Asset

fn sub_assign(&mut self, other: Asset)

Subtraction assignment operator

@param other - Another asset to subtract this asset with @post The amount of this asset is subtracted by the amount of asset other

impl Copy for Asset

impl Eq for Asset