Struct Display

pub struct Display { /* private fields */ }

A helper/builder that displays amount with specified settings.

This provides richer interface than fmt::Formatter:

• Ability to select denomination
• Show or hide denomination
• Dynamically-selected denomination - show in sats if less than 1 BTC.

However, this can still be combined with fmt::Formatter options to precisely control zeros, padding, alignment… The formatting works like floats from core but note that precision will never be lossy - that means no rounding.

Note: This implementation is currently unstable. The only thing that we can promise is that unless the precision is changed, this will display an accurate, human-readable number, and the default serialization (one with unmodified fmt::Formatter options) will round-trip with FromStr

See Amount::display_in and Amount::display_dynamic on how to construct this.

Implementations

impl Display

pub fn show_denomination(self) -> Self

Makes subsequent calls to Display::fmt display denomination.

Trait Implementations

impl Clone for Display

fn clone(&self) -> Display

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Display

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

Formats the value using the given formatter.

impl Display for Display

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

Formats the value using the given formatter.