Struct stellar_base::amount::Amount

pub struct Amount(_);

Amount in base units. For example, 2 XLM.

Implementations

impl Amount

pub fn from_stroops(stroops: &Stroops) -> Result<Amount>

Creates from amount specified in stroops.

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

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

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

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

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

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

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

Checked division. Computes self / other, returning None if overflow occurred or other == 0.0.

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

Checked division. Computes self % other, returning None if overflow occurred or other == 0.0.

pub fn to_stroops(&self) -> Result<Stroops>

Returns the equivalent amount in stroops.

Trait Implementations

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

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

Formats the value using the given formatter.

impl Eq for Amount

impl FromStr for Amount

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Amount>

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

impl Ord for Amount

fn cmp(&self, other: &Amount) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Amount> 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 PartialOrd<Amount> 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 StructuralEq for Amount

impl StructuralPartialEq for Amount

impl TryFrom<Amount> for Stroops

type Error = Error

The type returned in the event of a conversion error.

fn try_from(amount: Amount) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Stroops> for Amount

type Error = Error

The type returned in the event of a conversion error.

fn try_from(stroops: Stroops) -> Result<Self, Self::Error>

Performs the conversion.