Module amount

Source
Expand description

Bitcoin amounts.

This module mainly introduces the Amount and SignedAmount types. We refer to the documentation on the types for more information.

Modules§

serde
This module adds serde serialization and deserialization support for Amounts. Since there is not a default way to serialize and deserialize Amounts, multiple ways are supported and it’s up to the user to decide which serialiation to use. The provided modules can be used as follows:

Structs§

Amount
Amount
Display
A helper/builder that displays amount with specified settings.
InputTooLargeError
Error returned when the input string is too large.
InvalidCharacterError
Returned when the input contains an invalid character.
MissingDenominationError
Error returned when the denomination is empty.
MissingDigitsError
Error returned when digits were expected in the input but there were none.
OutOfRangeError
Returned when a parsed amount is too big or too small.
PossiblyConfusingDenominationError
Parsing error, possibly confusing denomination.
SignedAmount
SignedAmount
TooPreciseError
Error returned when the input string has higher precision than satoshis.
UnknownDenominationError
Parsing error, unknown denomination.

Enums§

Denomination
A set of denominations in which amounts can be expressed.
ParseAmountError
An error during amount parsing.
ParseDenominationError
An error during amount parsing.
ParseError
An error during amount parsing amount with denomination.

Traits§

CheckedSum
Calculate the sum over the iterator using checked arithmetic.