Struct SiFormatted 

pub struct SiFormatted<T> { /* private fields */ }

This is a number wrapped for formatting. The with_* methods can be used to customize display.

Implementations

impl<T> SiFormatted<T>

pub fn with_precision(self, significant_digits: usize) -> Self

The number of significant digits to display. Unlike the precision for std::fmt, this includes digits before the decimal point.

use si_format::Formattable;
assert_eq!(1234567.si_format().with_precision(5).to_string(),"1.234_6M");

Currently, this must be at least 3.

pub fn with_shift(self, shift: i8) -> Self

Multiply formatted value by a power of ten.

The input number x is formatted as if it were x*10^shift. This allows formatting of fractional quantities using integers:

use si_format::Formattable;
assert_eq!(format!("{}s",(22u64).si_format().with_shift(-3)),"22.0ms");

No actual multiplication is performed, the multiplied value need not be representable as T.

Trait Implementations

impl<T: FormatImpl> Debug for SiFormatted<T>

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

Formats the value using the given formatter.

impl<T: FormatImpl> Display for SiFormatted<T>

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

Formats the value using the given formatter.