Struct NumFmt

pub struct NumFmt { /* private fields */ }

Formatter for numbers.

Implementations

impl NumFmt

pub fn builder() -> Builder

Create a Builder to customize the parameters of a NumFmt.

pub fn from_str(s: &str) -> Result<Self, Error>

Parse a NumFmt instance from a format string.

See crate-level documentation for the grammar.

pub fn fmt<N: Numeric>(&self, number: N) -> Result<String, Error>

Format the provided number according to this configuration.

Will return None in the event that the configured format is incompatible with the number provided. This is most often the case when the number is not an integer but an integer format such as b, o, or x is configured.

pub fn fmt_with<N: Numeric>( &self, number: N, dynamic: Dynamic, ) -> Result<String, Error>

Format the provided number according to this configuration and dynamic parameters.

Note that dynamic parameters always override the formatter’s parameters:

let fmt = NumFmt::from_str("#04x_2").unwrap();
assert_eq!(fmt.fmt(0).unwrap(), "0x00");
assert_eq!(fmt.fmt_with(0, Dynamic::width(7)).unwrap(), "0x00_00");

Will return None in the event that the configured format is incompatible with the number provided. This is most often the case when the number is not an integer but an integer format such as b, o, or x is configured.

pub fn fill(&self) -> char

char used to pad the extra space when the rendered number is smaller than the width.

pub fn align(&self) -> Align

Desired alignment.

pub fn sign(&self) -> Sign

Which signs are printed with the number.

pub fn hash(&self) -> bool

Whether to print a base specification before the number.

pub fn zero(&self) -> bool

Whether the zero formatter was used.

pub fn width(&self) -> usize

Configured render width in bytes.

pub fn precision(&self) -> Option<usize>

Configured post-decimal precision in bytes.

Precision will pad or truncate as required if set. If unset, passes through as many digits past the decimal as the underlying type naturally returns.

pub fn base(&self) -> Base

Configured output format.

pub fn separator(&self) -> Option<char>

Configured group separator.

pub fn spacing(&self) -> Option<usize>

Configured group size.

pub fn decimal_separator(&self) -> char

Configured decimal separator.

Trait Implementations

impl Clone for NumFmt

fn clone(&self) -> NumFmt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NumFmt

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

Formats the value using the given formatter.

impl Default for NumFmt

fn default() -> NumFmt

Returns the “default value” for a type.

impl From<NumFmt> for Builder

fn from(_: NumFmt) -> Self

Converts to this type from the input type.

impl FromStr for NumFmt

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for NumFmt

fn eq(&self, other: &NumFmt) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for NumFmt

impl StructuralPartialEq for NumFmt