Struct lexical_core::write_float_options::OptionsBuilder

pub struct OptionsBuilder { /* private fields */ }

Builder for Options.

Implementations

impl OptionsBuilder

pub const fn new() -> OptionsBuilder

pub const fn get_max_significant_digits(&self) -> Option<NonZero<usize>>

Get the maximum number of significant digits to write.

pub const fn get_min_significant_digits(&self) -> Option<NonZero<usize>>

Get the minimum number of significant digits to write.

pub const fn get_positive_exponent_break(&self) -> Option<NonZero<i32>>

Get the maximum exponent prior to using scientific notation.

pub const fn get_negative_exponent_break(&self) -> Option<NonZero<i32>>

Get the minimum exponent prior to using scientific notation.

pub const fn get_round_mode(&self) -> RoundMode

Get the rounding mode for writing digits with precision control.

pub const fn get_trim_floats(&self) -> bool

Get if we should trim a trailing ".0" from floats.

pub const fn get_exponent(&self) -> u8

Get the character to designate the exponent component of a float.

pub const fn get_decimal_point(&self) -> u8

Get the character to separate the integer from the fraction components.

pub const fn get_nan_string(&self) -> Option<&'static [u8]>

Get the string representation for NaN.

pub const fn get_inf_string(&self) -> Option<&'static [u8]>

Get the short string representation for Infinity.

pub const fn max_significant_digits( self, max_significant_digits: Option<NonZero<usize>>, ) -> OptionsBuilder

Set the maximum number of significant digits to write.

pub const fn min_significant_digits( self, min_significant_digits: Option<NonZero<usize>>, ) -> OptionsBuilder

Set the minimum number of significant digits to write.

pub const fn positive_exponent_break( self, positive_exponent_break: Option<NonZero<i32>>, ) -> OptionsBuilder

Set the maximum exponent prior to using scientific notation.

pub const fn negative_exponent_break( self, negative_exponent_break: Option<NonZero<i32>>, ) -> OptionsBuilder

Set the minimum exponent prior to using scientific notation.

pub const fn round_mode(self, round_mode: RoundMode) -> OptionsBuilder

Set the rounding mode for writing digits with precision control.

pub const fn trim_floats(self, trim_floats: bool) -> OptionsBuilder

Set if we should trim a trailing ".0" from floats.

pub const fn exponent(self, exponent: u8) -> OptionsBuilder

Set the character to designate the exponent component of a float.

pub const fn decimal_point(self, decimal_point: u8) -> OptionsBuilder

Set the character to separate the integer from the fraction components.

pub const fn nan_string( self, nan_string: Option<&'static [u8]>, ) -> OptionsBuilder

Set the string representation for NaN.

Panics

Setting a value too large may cause a panic even if FORMATTED_SIZE elements are provided.

pub const fn inf_string( self, inf_string: Option<&'static [u8]>, ) -> OptionsBuilder

Set the string representation for Infinity.

Panics

Setting a value too large may cause a panic even if FORMATTED_SIZE elements are provided.

pub const fn nan_str_is_valid(&self) -> bool

Determine if nan_str is valid.

pub const fn inf_str_is_valid(&self) -> bool

Determine if inf_str is valid.

pub const fn is_valid(&self) -> bool

Check if the builder state is valid.

pub const fn build_unchecked(&self) -> Options

Build the Options struct without validation.

Panics

This is completely safe, however, misusing this, especially the nan_string and inf_string representations could cause panics at runtime. Always use [MAX_SPECIAL_STRING_LENGTH] and check if Self::is_valid prior to using a created format string.

pub const fn build(&self) -> Result<Options, Error>

Build the Options struct.

Trait Implementations

impl Clone for OptionsBuilder

fn clone(&self) -> OptionsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OptionsBuilder

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

Formats the value using the given formatter.

impl Default for OptionsBuilder

fn default() -> OptionsBuilder

Returns the “default value” for a type.

impl PartialEq for OptionsBuilder

fn eq(&self, other: &OptionsBuilder) -> 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 OptionsBuilder

impl StructuralPartialEq for OptionsBuilder