Struct Amount

pub struct Amount(/* private fields */);

Amount can be any unit

Implementations

impl Amount

pub const ZERO: Amount

Amount zero

pub const ONE: Amount

Amount one

pub fn split(&self) -> Vec<Amount>

Split into parts that are powers of two

pub fn split_targeted(&self, target: &SplitTarget) -> Result<Vec<Amount>, Error>

Split into parts that are powers of two by target

pub fn split_with_fee(&self, fee_ppk: u64) -> Result<Vec<Amount>, Error>

Splits amount into powers of two while accounting for the swap fee

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

Checked addition for Amount. Returns None if overflow occurs.

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

Checked subtraction for Amount. Returns None if overflow occurs.

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

Checked multiplication for Amount. Returns None if overflow occurs.

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

Checked division for Amount. Returns None if overflow occurs.

pub fn try_sum<I>(iter: I) -> Result<Amount, Error>

where I: IntoIterator<Item = Amount>,

Try sum to check for overflow

Trait Implementations

impl Add for Amount

type Output = Amount

The resulting type after applying the + operator.

fn add(self, rhs: Amount) -> <Amount as Add>::Output

Performs the + operation.

impl AddAssign for Amount

fn add_assign(&mut self, rhs: Amount)

Performs the += operation.

impl AsRef<u64> for Amount

fn as_ref(&self) -> &u64

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

impl Clone for Amount

fn clone(&self) -> Amount

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl Default for &Amount

fn default() -> &Amount

Returns the “default value” for a type.

impl Default for Amount

fn default() -> Amount

Returns the “default value” for a type.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<Amount, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Amount

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

Formats the value using the given formatter.

impl Div for Amount

type Output = Amount

The resulting type after applying the / operator.

fn div(self, other: Amount) -> <Amount as Div>::Output

Performs the / operation.

impl From<&u64> for Amount

fn from(value: &u64) -> Amount

Converts to this type from the input type.

impl From<u64> for Amount

fn from(value: u64) -> Amount

Converts to this type from the input type.

impl FromStr for Amount

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Amount, <Amount as FromStr>::Err>

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

impl Hash for Amount

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

where __H: Hasher,

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

type Output = Amount

The resulting type after applying the * operator.

fn mul(self, other: Amount) -> <Amount as Mul>::Output

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,

Restrict a value to a certain interval.

impl PartialEq for Amount

fn eq(&self, other: &Amount) -> 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 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

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

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, rhs: Amount) -> <Amount as Sub>::Output

Performs the - operation.

impl SubAssign for Amount

fn sub_assign(&mut self, other: Amount)

Performs the -= operation.

impl Copy for Amount

impl Eq for Amount

impl StructuralPartialEq for Amount