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.

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_int(&self, number: impl Into<isize>) -> FormatResult<DECIMALS>

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

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

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

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

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

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

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

We recommend that you use format_float or format_int.

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.

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>