Struct stellar_client::resources::Amount

pub struct Amount(_);

Amounts are used in several resources in the stellar ecosystem. There are a lot of conversions that must take place to display amounts to users in a way that makes sense to both users and the horizon API. That logic is contained in this module.

https://www.stellar.org/developers/guides/concepts/assets.html#amount-precision-and-representation

Methods

impl Amount

pub fn new(amount: i64) -> Amount

Create an amount newtype

Trait Implementations

impl Debug for Amount

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

Formats the value using the given formatter.

impl Eq for Amount

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: &Amount) -> bool

This method tests for !=.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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: &Amount) -> bool

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

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

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

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

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

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

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

impl Copy for Amount

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<'a> Add for &'a Amount

type Output = Amount

The resulting type after applying the + operator.

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

Adding two amounts returns a new amount with the value being the sum of the two input values

impl<'a> Sub for &'a Amount

type Output = Amount

The resulting type after applying the - operator.

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

Subtracting two amounts returns a new amount with the value being the difference of the two values.

impl Display for Amount

We convert amounts to their stroop values (multiply by 10^7) on serialization. When displaying values for end users, they are likely more interested in the unit values, so we divide by 10^7

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

Formats the value using the given formatter.

impl Serialize for Amount

Converts internally stored stroop value of asset amount into full unit amount and returns a serialized string of the result.

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

Serialize this value into the given Serde serializer.

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

The stellar ammount fields are represented as strings in the horizon api, however, they look like floats. But, in the actual ledger they are signed 64-bit integers. This function converts what we get from horizon into a signed integer. The precision of the float is assumed to be out to 7 digits (but if fewer are found it's ok).

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

Deserialize this value from the given Serde deserializer.

impl FromStr for Amount

type Err = ParseAmountError

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.