Struct lexical_parse_float::Options

pub struct Options { /* private fields */ }

Options to customize parsing floats.

Examples

use lexical_parse_float::Options;

let options = Options::builder()
    .lossy(true)
    .nan_string(Some(b"NaN"))
    .inf_string(Some(b"Inf"))
    .infinity_string(Some(b"Infinity"))
    .build()
    .unwrap();

Implementations

impl Options

pub const fn new() -> Self

Create options with default values.

pub const fn is_valid(&self) -> bool

Check if the options state is valid.

pub const fn lossy(&self) -> bool

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

pub const fn exponent(&self) -> u8

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

pub const fn decimal_point(&self) -> u8

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

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

Get the string representation for NaN.

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

Get the short string representation for Infinity.

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

Get the long string representation for Infinity.

pub unsafe fn set_lossy(&mut self, lossy: bool)

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

Safety

Always safe, just marked as unsafe for API compatibility.

pub unsafe fn set_exponent(&mut self, exponent: u8)

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

Safety

Always safe, but may produce invalid output if the exponent is not a valid ASCII character.

pub unsafe fn set_decimal_point(&mut self, decimal_point: u8)

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

Safety

Always safe, but may produce invalid output if the decimal point is not a valid ASCII character.

pub unsafe fn set_nan_string(&mut self, nan_string: Option<&'static [u8]>)

Set the string representation for NaN. Unsafe, use the builder API for option validation.

Safety

Always safe, just marked as unsafe for API compatibility.

pub unsafe fn set_inf_string(&mut self, inf_string: Option<&'static [u8]>)

Set the short string representation for Infinity Unsafe, use the builder API for option validation.

Safety

Always safe, just marked as unsafe for API compatibility.

pub unsafe fn set_infinity_string(
    &mut self,
    infinity_string: Option<&'static [u8]>
)

Set the long string representation for Infinity Unsafe, use the builder API for option validation.

Safety

Always safe, just marked as unsafe for API compatibility.

pub const fn builder() -> OptionsBuilder

Get OptionsBuilder as a static function.

pub const fn rebuild(&self) -> OptionsBuilder

Create OptionsBuilder using existing values.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.

impl Ord for Options

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParseOptions for Options

fn is_valid(&self) -> bool

Determine if the options are valid.

impl PartialEq<Options> for Options

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

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for Options

impl StructuralEq for Options

impl StructuralPartialEq for Options