Struct lexical_core::parse_float_options::OptionsBuilder

pub struct OptionsBuilder { /* private fields */ }

Builder for Options.

Implementations

impl OptionsBuilder

pub const fn new() -> OptionsBuilder

Create new options builder with default options.

pub const fn get_lossy(&self) -> bool

Get if we disable the use of arbitrary-precision arithmetic.

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 get_infinity_string(&self) -> Option<&'static [u8]>

Get the long string representation for Infinity.

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

Set if we disable the use of arbitrary-precision arithmetic.

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.

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

Set the short string representation for Infinity.

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

Set the long string representation for Infinity.

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 infinity_string_is_valid(&self) -> bool

Determine if infinity_string 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, inf_string, and infinity_string could panic 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.

Errors

If the NaN, Inf, or Infinity strings are too long or invalid digits/characters are provided for some numerical formats.

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 Ord for OptionsBuilder

fn cmp(&self, other: &OptionsBuilder) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

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 PartialOrd for OptionsBuilder

fn partial_cmp(&self, other: &OptionsBuilder) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for OptionsBuilder

impl StructuralPartialEq for OptionsBuilder