Struct Amount 

pub struct Amount { /* private fields */ }

A quantity of a Hive asset, held as an integer count of its smallest unit.

Implementations

impl Amount

pub fn from_units(units: i64, symbol: &str, chain: Chain) -> Result<Self>

Build from a raw unit count and a symbol on the given chain.

pub fn parse(s: &str, chain: Chain) -> Result<Self>

Parse Hive’s textual amount form, "1.234 HIVE".

The decimal string is converted to an integer directly. A value with more decimal places than the asset allows is an error, not a silent truncation: quietly dropping a digit from a monetary amount transfers a different sum than the caller asked for.

pub fn units(&self) -> i64

The raw unit count.

pub fn precision(&self) -> u8

The asset’s decimal places.

pub fn symbol(&self) -> &'static str

The display symbol, e.g. HIVE.

pub fn wire_symbol(&self) -> &'static str

The symbol used in the legacy binary encoding, e.g. STEEM.

pub fn is_zero(&self) -> bool

Whether this is exactly zero.

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

Add two amounts of the same asset. Refuses a mismatch rather than coercing.

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

Subtract two amounts of the same asset.

pub fn to_nai_json(&self, chain: Chain) -> Result<Value>

The NAI-style JSON form used by database_api: {"amount": "1234", "precision": 3, "nai": "@@000000021"}.

Trait Implementations

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

impl Debug for Amount

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

Formats the value using the given formatter.

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

Amounts arrive from the API in two different shapes, and both are accepted.

condenser_api and the legacy forms send the textual "1.234 HIVE". database_api and account_history_api in appbase mode send the NAI object {"amount": "1234", "precision": 3, "nai": "@@000000021"}. beem handled both too, but by branching on isinstance inside Amount.__init__ across four cases.

Deserialization resolves symbols against Hive mainnet. For a testnet, decode the raw JSON and use Amount::from_units with the right chain.

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

Deserialize this value from the given Serde deserializer.

impl Display for Amount

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

Render as "1.234 HIVE", always with exactly precision decimal places.

impl Eq for Amount

impl GrapheneDeserialize for Amount

fn read_from(r: &mut Reader<'_>) -> Result<Self>

Read the 16-byte legacy asset: int64 units, uint8 precision, 7-byte NUL-padded symbol.

The symbol is resolved against the reader’s chain and cross-checked: an asset whose declared precision disagrees with the chain’s is refused rather than silently reinterpreted, because that mismatch means the bytes are not the asset they claim to be.

impl GrapheneSerialize for Amount

fn append_to(&self, out: &mut Vec<u8>) -> Result<()>

Append this value’s wire encoding to out.

fn to_wire(&self) -> Result<Vec<u8>>

Encode this value to a fresh buffer.

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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for Amount

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

Equality operator ==.

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

Inequality operator !=.

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

Amounts render in Hive’s textual form, "1.234 HIVE", which is what condenser_api and network_broadcast_api accept.

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Amount