Struct ParseFloatOptions

Source

pub struct ParseFloatOptions { /* private fields */ }

Available on crate feature parse-floats only.

Expand description

Options to customize parsing floats.

This enables extensive control over how the float is parsed, from control characters like the decimal point and the valid non-finite float representations.

§Examples

use lexical_parse_float::{FromLexicalWithOptions, Options};
use lexical_parse_float::format::STANDARD;

const OPTIONS: Options = Options::builder()
    .lossy(true)
    .nan_string(Some(b"NaN"))
    .inf_string(Some(b"Inf"))
    .infinity_string(Some(b"Infinity"))
    .build_strict();

let value = "1.2345e300";
let result = f64::from_lexical_with_options::<STANDARD>(value.as_bytes(), &OPTIONS);
assert_eq!(result, Ok(1.2345e300));

let value = "NaN";
let result = f64::from_lexical_with_options::<STANDARD>(value.as_bytes(), &OPTIONS);
assert_eq!(result.map(|x| x.is_nan()), Ok(true));

Implementations§

Source §

impl Options

Source

pub const fn new() -> Options

Create options with default values.

Source

pub const fn from_radix(radix: u8) -> Options

Create the default options for a given radix.

This sets the exponent to ^ for any radix where e would be a valid digit.

Source

pub const fn is_valid(&self) -> bool

Check if the options state is valid.

Source

pub const fn lossy(&self) -> bool

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

Lossy algorithms never use the fallback, slow algorithm. Defaults to false.

§Examples

use lexical_parse_float::options::Options;

assert_eq!(Options::new().lossy(), false);

Source

pub const fn exponent(&self) -> u8

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

Any non-control character is valid, but \t to \r are also valid. The full range is [0x09, 0x0D] and [0x20, 0x7F]. Defaults to e.

§Examples

use lexical_parse_float::options::Options;

assert_eq!(Options::new().exponent(), b'e');

Source

pub const fn decimal_point(&self) -> u8

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

Any non-control character is valid, but \t to \r are also valid. The full range is [0x09, 0x0D] and [0x20, 0x7F]. Defaults to ..

§Examples

use lexical_parse_float::options::Options;

assert_eq!(Options::new().decimal_point(), b'.');

Source

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

Get the string representation for NaN.

The first character must start with N or n and all characters must be valid ASCII letters (A-Z or a-z). If set to None, then parsing NaN returns an error. Defaults to NaN.

§Examples

use lexical_parse_float::options::Options;

assert_eq!(Options::new().nan_string(), Some(b"NaN".as_ref()));

Source

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

Get the short string representation for Infinity.

The first character must start with I or i and all characters must be valid ASCII letters (A-Z or a-z). If set to None, then parsing Infinity returns an error. Defaults to inf.

§Examples

use lexical_parse_float::options::Options;

assert_eq!(Options::new().inf_string(), Some(b"inf".as_ref()));

Source

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

Get the long string representation for Infinity.

The first character must start with I or i and all characters must be valid ASCII letters (A-Z or a-z). If set to None, then parsing Infinity returns an error. Defaults to infinity.