Struct lexical_core::write_float_options::Options

source ·
pub struct Options { /* private fields */ }
Expand description

Options to customize writing floats.

§Examples

use lexical_write_float::Options;

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

Implementations§

source§

impl Options

source

pub const fn new() -> Options

Create options with default values.

source

pub const fn is_valid(&self) -> bool

Check if the options state is valid.

source

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

Get the maximum number of significant digits to write.

source

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

Get the minimum number of significant digits to write.

source

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

Get the maximum exponent prior to using scientific notation.

source

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

Get the minimum exponent prior to using scientific notation.

source

pub const fn round_mode(&self) -> RoundMode

Get the rounding mode for writing digits with precision control.

source

pub const fn trim_floats(&self) -> bool

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

source

pub const fn exponent(&self) -> u8

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

source

pub const fn decimal_point(&self) -> u8

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

source

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

Get the string representation for NaN.

source

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

Get the short string representation for Infinity.

source

pub unsafe fn set_max_significant_digits( &mut self, max_significant_digits: Option<NonZero<usize>>, )

Set the maximum number of significant digits to write. Unsafe, use the builder API for option validation.

§Safety

Always safe, just marked as unsafe for API compatibility.

source

pub unsafe fn set_min_significant_digits( &mut self, min_significant_digits: Option<NonZero<usize>>, )

Set the minimum number of significant digits to write. Unsafe, use the builder API for option validation.

§Safety

Always safe, just marked as unsafe for API compatibility.

source

pub unsafe fn set_positive_exponent_break( &mut self, positive_exponent_break: Option<NonZero<i32>>, )

Set the maximum exponent prior to using scientific notation.

§Safety

Always safe, just marked as unsafe for API compatibility.

source

pub unsafe fn set_negative_exponent_break( &mut self, negative_exponent_break: Option<NonZero<i32>>, )

Set the minimum exponent prior to using scientific notation.

§Safety

Always safe, just marked as unsafe for API compatibility.

source

pub unsafe fn set_round_mode(&mut self, round_mode: RoundMode)

Set the rounding mode for writing digits with precision control.

§Safety

Always safe, just marked as unsafe for API compatibility.

source

pub unsafe fn set_trim_floats(&mut self, trim_floats: bool)

Set if we should trim a trailing ".0" from floats. Unsafe, use the builder API for option validation.

§Safety

Always safe, just marked as unsafe for API compatibility.

source

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.

source

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.

source

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

Unsafe if nan_string.len() > MAX_SPECIAL_STRING_LENGTH. This might cause a special string larger than the buffer length to be written, causing a buffer overflow, potentially a severe security vulnerability.

source

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

Unsafe if nan_string.len() > MAX_SPECIAL_STRING_LENGTH. This might cause a special string larger than the buffer length to be written, causing a buffer overflow, potentially a severe security vulnerability.

source

pub const fn builder() -> OptionsBuilder

Get WriteFloatOptionsBuilder as a static function.

source

pub const fn rebuild(&self) -> OptionsBuilder

Create OptionsBuilder using existing values.

Trait Implementations§

source§

impl Clone for Options

source§

fn clone(&self) -> Options

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Options

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Options

source§

fn default() -> Options

Returns the “default value” for a type. Read more
source§

impl PartialEq for Options

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl WriteOptions for Options

source§

fn is_valid(&self) -> bool

Determine if the options are valid.
source§

fn buffer_size<T, const FORMAT: u128>(&self) -> usize
where T: FormattedSize,

Get an upper bound on the buffer size.
source§

impl Eq for Options

source§

impl StructuralPartialEq for Options

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.