Struct Formatter

pub struct Formatter<const BASE: usize = 0, const DECIMALS: usize = 2> { /* private fields */ }

Entry point to the lib. Use this to handle your formatting needs.

• BASE: the base
• DECIMALS: target decimal places (if not keeping the original number)

Implementations

impl Formatter

pub const SI: Formatter<1000, 2>

SI units (western format).

pub const BINARY: Formatter<1024, 2>

Binary units (western format).

pub const CHINESE: Formatter<10000, 2>

Chinese units.

impl<const BASE: usize, const DECIMALS: usize> Formatter<BASE, DECIMALS>

pub const fn new(units: &'static [&'static str]) -> Self

Create a new Formatter with given BASE, DECIMALS and units.

pub const fn with_separator(self, separator: &'static str) -> Self

Set the separator between numbers and units.

pub const fn with_scales<const N_BASE: usize>( self, units: &'static [&'static str], ) -> Formatter<N_BASE, DECIMALS>

Set scales, including base and the abbreviated number’s units.

pub const fn with_custom_unit(self, custom_unit: &'static str) -> Self

Set custom unit attached after the abbreviated number’s unit.

pub const fn with_decimals<const N_DECIMALS: usize>( self, ) -> Formatter<BASE, N_DECIMALS>

Set the decimal places to keep.

pub fn format(&self, number: impl NumberT) -> FormatResult<DECIMALS>

Formats the given number into a human-readable string using the specified units and separator.

See NumberT for all types we accept as param.

Notice

For better performance (may be so), you may need format_int or format_uint.

Limitation

f64 can only handle 15 decimal places at most. We may introduce macro_toolset for large number formatting.

pub fn format_int(&self, number: impl Into<i128>) -> FormatResult<DECIMALS>

Formats the given number into a human-readable string using the specified units and separator.

We accept any number that fits into isize. For i128, see format_large_int.

pub fn format_uint(&self, number: impl Into<u128>) -> FormatResult<DECIMALS>

Formats the given number into a human-readable string using the specified units and separator.

pub fn format_general( &self, integer: u128, fraction: Option<f64>, ) -> FormatResult<DECIMALS>

Formats the given number into a human-readable string using the specified units and separator.

Params

• integer: the integer part of the number.
  • For float, f32::trunc or f64::trunc may helps you.
• fraction: the fractional part of the number.
  • For float, f32::fract or f64::fract may helps you.
  • For integer, leave it None.

Notice

It’s NOT recommended that you use this directly, use format instead unless you know exactly what you do.

pub fn format_float(&self, number: f64) -> FormatResult<DECIMALS>

Formats the given number into a human-readable string using the specified units and separator.

Notice

It’s NOT recommended that you use this directly, floating point calculation often slower than integer arithmetic. Use format instead unless you know exactly what you do.

Trait Implementations

impl<const BASE: usize, const DECIMALS: usize> Clone for Formatter<BASE, DECIMALS>

fn clone(&self) -> Formatter<BASE, DECIMALS>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const BASE: usize, const DECIMALS: usize> Debug for Formatter<BASE, DECIMALS>

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

Formats the value using the given formatter.

impl<const BASE: usize, const DECIMALS: usize> Copy for Formatter<BASE, DECIMALS>