Struct re_format::FloatFormatOptions

pub struct FloatFormatOptions {
    pub always_sign: bool,
    pub precision: usize,
    pub num_decimals: Option<usize>,
    pub strip_trailing_zeros: bool,
    pub min_decimals_for_thousands_separators: usize,
}

Options for how to format a floating point number, e.g. an f64.

Fields

always_sign: bool

Always show the sign, even if it is positive (+).

precision: usize

Maximum digits of precision to use.

This includes both the integer part and the fractional part.

num_decimals: Option<usize>

Max number of decimals to show after the decimal point.

If not specified, Self::precision is used instead.

strip_trailing_zeros: bool

min_decimals_for_thousands_separators: usize

Only add thousands separators to decimals if there are at least this many decimals.

Implementations

impl FloatFormatOptions

pub const DEFAULT_f32: Self = _

Default options for formatting an f32.

pub const DEFAULT_f64: Self = _

Default options for formatting an f64.

pub fn with_always_sign(self, always_sign: bool) -> Self

Always show the sign, even if it is positive (+).

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

Show at most this many digits of precision, including both the integer part and the fractional part.

pub fn with_decimals(self, num_decimals: usize) -> Self

Max number of decimals to show after the decimal point.

If not specified, Self::precision is used instead.

pub fn with_strip_trailing_zeros(self, strip_trailing_zeros: bool) -> Self

Strip trailing zeros from decimal expansion?

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

The returned value is for human eyes only, and can not be parsed by the normal f64::from_str function.

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

Trait Implementations

impl Clone for FloatFormatOptions

fn clone(&self) -> FloatFormatOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FloatFormatOptions

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

Formats the value using the given formatter.

impl Hash for FloatFormatOptions

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FloatFormatOptions

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for FloatFormatOptions

impl Eq for FloatFormatOptions

impl StructuralPartialEq for FloatFormatOptions