Struct tapyrus::util::amount::Amount

source ·
pub struct Amount(/* private fields */);
Expand description

Amount

The Amount type can be used to express TPC amounts that supports arithmetic and conversion to various denominations.

Warning!

This type implements several arithmetic operations from std::ops. To prevent errors due to overflow or underflow when using these operations, it is advised to instead use the checked arithmetic methods whose names start with checked_. The operations from std::ops that Amount implements will panic when overflow or underflow occurs. Also note that since the internal representation of amounts is unsigned, subtracting below zero is considered an underflow and will cause a panic if you’re not using the checked arithmetic methods.

Implementations§

source§

impl Amount

source

pub const ZERO: Amount = _

The zero amount.

source

pub const ONE_TAP: Amount = _

Exactly one tapyrus.

source

pub const ONE_TPC: Amount = _

Exactly one TPC.

source

pub fn from_tap(tapyrus: u64) -> Amount

Create an Amount with tapyrus precision and the given number of tapyrus.

source

pub fn as_tap(self) -> u64

Get the number of tapyrus in this Amount.

source

pub fn max_value() -> Amount

The maximum value of an Amount.

source

pub fn min_value() -> Amount

The minimum value of an Amount.

source

pub fn from_tpc(tpc: f64) -> Result<Amount, ParseAmountError>

Convert from a value expressing tpcs to an Amount.

source

pub fn from_str_in( s: &str, denom: Denomination ) -> Result<Amount, ParseAmountError>

Parse a decimal string as a value in the given denomination.

Note: This only parses the value string. If you want to parse a value with denomination, use FromStr.

source

pub fn from_str_with_denomination(s: &str) -> Result<Amount, ParseAmountError>

Parses amounts with denomination suffix like they are produced with [to_string_with_denomination] or with fmt::Display. If you want to parse only the amount without the denomination, use [from_str_in].

source

pub fn to_float_in(self, denom: Denomination) -> f64

Express this Amount as a floating-point value in the given denomination.

Please be aware of the risk of using floating-point numbers.

source

pub fn as_tpc(self) -> f64

Express this Amount as a floating-point value in TPC.

Equivalent to to_float_in(Denomination::TPC).

Please be aware of the risk of using floating-point numbers.

source

pub fn from_float_in( value: f64, denom: Denomination ) -> Result<Amount, ParseAmountError>

Convert this Amount in floating-point notation with a given denomination. Can return error if the amount is too big, too precise or negative.

Please be aware of the risk of using floating-point numbers.

source

pub fn fmt_value_in(self, f: &mut dyn Write, denom: Denomination) -> Result

Format the value of this Amount in the given denomination.

Does not include the denomination.

source

pub fn to_string_in(self, denom: Denomination) -> String

Get a string number of this Amount in the given denomination.

Does not include the denomination.

source

pub fn to_string_with_denomination(self, denom: Denomination) -> String

Get a formatted string of this Amount in the given denomination, suffixed with the abbreviation for the denomination.

source

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

Checked addition. Returns None if overflow occurred.

source

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

Checked subtraction. Returns None if overflow occurred.

source

pub fn checked_mul(self, rhs: u64) -> Option<Amount>

Checked multiplication. Returns None if overflow occurred.

source

pub fn checked_div(self, rhs: u64) -> Option<Amount>

Checked integer division. Be aware that integer division loses the remainder if no exact division can be made. Returns None if overflow occurred.

source

pub fn checked_rem(self, rhs: u64) -> Option<Amount>

Checked remainder. Returns None if overflow occurred.

source

pub fn to_signed(self) -> Result<SignedAmount, ParseAmountError>

Convert to a signed amount.

Trait Implementations§

source§

impl Add for Amount

§

type Output = Amount

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

impl AddAssign for Amount

source§

fn add_assign(&mut self, other: Amount)

Performs the += operation. Read more
source§

impl Clone for Amount

source§

fn clone(&self) -> Amount

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Amount

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Amount

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Display for Amount

source§

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

Formats the value using the given formatter. Read more
source§

impl Div<u64> for Amount

§

type Output = Amount

The resulting type after applying the / operator.
source§

fn div(self, rhs: u64) -> Self::Output

Performs the / operation. Read more
source§

impl DivAssign<u64> for Amount

source§

fn div_assign(&mut self, rhs: u64)

Performs the /= operation. Read more
source§

impl FromStr for Amount

§

type Err = ParseAmountError

The associated error which can be returned from parsing.
source§

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

Parses a string s to return a value of this type. Read more
source§

impl Hash for Amount

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl Mul<u64> for Amount

§

type Output = Amount

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl MulAssign<u64> for Amount

source§

fn mul_assign(&mut self, rhs: u64)

Performs the *= operation. Read more
source§

impl Ord for Amount

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Amount

source§

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

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

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.
source§

impl PartialOrd for Amount

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Rem<u64> for Amount

§

type Output = Amount

The resulting type after applying the % operator.
source§

fn rem(self, modulus: u64) -> Self

Performs the % operation. Read more
source§

impl RemAssign<u64> for Amount

source§

fn rem_assign(&mut self, modulus: u64)

Performs the %= operation. Read more
source§

impl Sub for Amount

§

type Output = Amount

The resulting type after applying the - operator.
source§

fn sub(self, rhs: Amount) -> Self::Output

Performs the - operation. Read more
source§

impl SubAssign for Amount

source§

fn sub_assign(&mut self, other: Amount)

Performs the -= operation. Read more
source§

impl Copy for Amount

source§

impl Eq for Amount

source§

impl StructuralEq for Amount

source§

impl StructuralPartialEq for Amount

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Az for T

source§

fn az<Dst>(self) -> Dstwhere T: Cast<Dst>,

Casts the value.
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CheckedAs for T

source§

fn checked_as<Dst>(self) -> Option<Dst>where T: CheckedCast<Dst>,

Casts the value.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> OverflowingAs for T

source§

fn overflowing_as<Dst>(self) -> (Dst, bool)where T: OverflowingCast<Dst>,

Casts the value.
source§

impl<T> SaturatingAs for T

source§

fn saturating_as<Dst>(self) -> Dstwhere T: SaturatingCast<Dst>,

Casts the value.
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> UnwrappedAs for T

source§

fn unwrapped_as<Dst>(self) -> Dstwhere T: UnwrappedCast<Dst>,

Casts the value.
source§

impl<T> WrappingAs for T

source§

fn wrapping_as<Dst>(self) -> Dstwhere T: WrappingCast<Dst>,

Casts the value.