Struct Formatter

pub struct Formatter { /* private fields */ }

Available on crate features progress and unit-human only.

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

Implementations

impl Formatter

pub fn new() -> Formatter

Initializes a new Formatter with default values.

pub fn with_decimals(&mut self, decimals: usize) -> &mut Formatter

Sets the decimals value for formatting the string.

pub fn with_separator(&mut self, separator: &str) -> &mut Formatter

Sets the separator value for formatting the string.

pub fn with_scales(&mut self, scales: Scales) -> &mut Formatter

Sets the scales value.

pub fn with_units(&mut self, units: &str) -> &mut Formatter

Sets the units value.

pub fn with_suffix(&mut self, suffix: &str) -> &mut Formatter

Sets the expected suffix value.

pub fn format(&self, value: f64) -> String

Formats the number into a string

pub fn parse(&self, value: &str) -> f64

Parse a string back into a float value.

pub fn try_parse(&self, value: &str) -> Result<f64, String>

Attempt to parse a string back into a float value.

Trait Implementations

impl Debug for Formatter

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

Formats the value using the given formatter.

impl Default for Formatter

fn default() -> Formatter

Returns the “default value” for a type.