Struct Amount

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

Implementations

impl Amount

pub const ZERO: Amount

pub fn from_strict_val_unchecked(value: &StrictVal) -> Amount

pub fn with_precision(amount: u64, precision: impl Into<Precision>) -> Amount

pub fn with_precision_checked( amount: u64, precision: impl Into<Precision>, ) -> Option<Amount>

pub fn value(self) -> u64

pub fn split(self, precision: impl Into<Precision>) -> (u64, u64)

pub fn round(&self, precision: impl Into<Precision>) -> u64

pub fn ceil(&self, precision: impl Into<Precision>) -> u64

pub fn floor(&self, precision: impl Into<Precision>) -> u64

pub fn rem(&self, precision: impl Into<Precision>) -> u64

pub fn saturating_add(&self, other: impl Into<Amount>) -> Amount

pub fn saturating_sub(&self, other: impl Into<Amount>) -> Amount

pub fn saturating_add_assign(&mut self, other: impl Into<Amount>)

pub fn saturating_sub_assign(&mut self, other: impl Into<Amount>)

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

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

pub fn checked_add_assign(&mut self, other: impl Into<Amount>) -> Option<()>

pub fn checked_sub_assign(&mut self, other: impl Into<Amount>) -> Option<()>

Trait Implementations

impl Add for Amount

type Output = Amount

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Amount

fn add_assign(&mut self, rhs: Amount)

Performs the += operation.

impl AsMut<<Amount as Wrapper>::Inner> for Amount

fn as_mut(&mut self) -> &mut <Amount as Wrapper>::Inner

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

impl AsRef<u64> for Amount

fn as_ref(&self) -> &u64

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

impl Borrow<u64> for Amount

fn borrow(&self) -> &u64

Immutably borrows from an owned value.

impl BorrowMut<<Amount as Wrapper>::Inner> for Amount

fn borrow_mut(&mut self) -> &mut <Amount as Wrapper>::Inner

Mutably borrows from an owned value.

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<'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, rhs: Amount) -> Amount

Performs the / operation.

impl DivAssign for Amount

fn div_assign(&mut self, rhs: Amount)

Performs the /= operation.

impl From<Amount> for AllocatedState

fn from(v: Amount) -> Self

Converts to this type from the input type.

impl From<Amount> for FungibleState

fn from(amount: Amount) -> FungibleState

Converts to this type from the input type.

impl From<Amount> for RevealedValue

fn from(amount: Amount) -> RevealedValue

Converts to this type from the input type.

impl From<FungibleState> for Amount

fn from(state: FungibleState) -> Amount

Converts to this type from the input type.

impl From<RevealedValue> for Amount

fn from(value: RevealedValue) -> Amount

Converts to this type from the input type.

impl From<Sats> for Amount

fn from(v: Sats) -> Amount

Converts to this type from the input type.

impl From<u16> for Amount

fn from(v: u16) -> Amount

Converts to this type from the input type.

impl From<u32> for Amount

fn from(v: u32) -> Amount

Converts to this type from the input type.

impl From<u64> for Amount

fn from(v: u64) -> Amount

Converts to this type from the input type.

impl From<u8> for Amount

fn from(v: u8) -> Amount

Converts to this type from the input type.

impl FromStr for Amount

type Err = DecodeError

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

const IS_FUNGIBLE: bool = true

impl Mul for Amount

type Output = Amount

The resulting type after applying the * operator.

fn mul(self, rhs: Amount) -> Amount

Performs the * operation.

impl MulAssign for Amount

fn mul_assign(&mut self, rhs: Amount)

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

type Output = Amount

The resulting type after applying the % operator.

fn rem(self, rhs: Amount) -> Amount

Performs the % operation.

impl RemAssign for Amount

fn rem_assign(&mut self, rhs: Amount)

Performs the %= operation.

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

fn strict_decode(reader: &mut impl TypedRead) -> Result<Amount, DecodeError>

fn strict_read(reader: impl ReadRaw) -> Result<Self, DecodeError>

impl StrictDeserialize for Amount

fn from_strict_serialized<const MAX: usize>( ast_data: Confined<Vec<u8>, 0, MAX>, ) -> Result<Self, DeserializeError>

fn strict_deserialize_from_file<const MAX: usize>( path: impl AsRef<Path>, ) -> Result<Self, DeserializeError>

impl StrictEncode for Amount

fn strict_encode<W>(&self, writer: W) -> Result<W, Error>

where W: TypedWrite,

fn strict_write(&self, writer: impl WriteRaw) -> Result<(), Error>

impl StrictSerialize for Amount

fn strict_serialized_len<const MAX: usize>(&self) -> Result<usize, Error>

fn to_strict_serialized<const MAX: usize>( &self, ) -> Result<Confined<Vec<u8>, 0, MAX>, SerializeError>

fn strict_serialize_to_file<const MAX: usize>( &self, path: impl AsRef<Path>, ) -> Result<(), SerializeError>

impl StrictTuple for Amount

const FIELD_COUNT: u8 = 1u8

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl StrictType for Amount

const STRICT_LIB_NAME: &'static str = LIB_NAME_RGB_CONTRACT

fn strict_name() -> Option<TypeName>

impl Sub for Amount

type Output = Amount

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Amount

fn sub_assign(&mut self, rhs: Amount)

Performs the -= operation.

impl Sum<u64> for Amount

fn sum<I>(iter: I) -> Amount

where I: Iterator<Item = u64>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Sum for Amount

fn sum<I>(iter: I) -> Amount

where I: Iterator<Item = Amount>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Wrapper for Amount

type Inner = u64

Inner type wrapped by the current newtype

fn from_inner(inner: <Amount as Wrapper>::Inner) -> Amount

Instantiates wrapper type with the inner data

fn as_inner(&self) -> &<Amount as Wrapper>::Inner

Returns reference to the inner representation for the wrapper type

fn into_inner(self) -> <Amount as Wrapper>::Inner

Unwraps the wrapper returning the inner type

fn to_inner(&self) -> Self::Inner

where Self::Inner: Clone,

Clones inner data of the wrapped type and return them

fn copy(&self) -> Self

where Self: Sized, Self::Inner: Copy,

Copies the wrapped type

impl WrapperMut for Amount

fn as_inner_mut(&mut self) -> &mut <Amount as Wrapper>::Inner

Returns a mutable reference to the inner representation for the wrapper type

impl Copy for Amount

impl Eq for Amount

impl StrictProduct for Amount

impl StructuralPartialEq for Amount