Skip to main content

FloatFormat

Struct FloatFormat 

Source
pub struct FloatFormat<'a>(/* private fields */);
Expand description

A validated floating-point format for ImPlot values.

ImPlot promotes the corresponding values to double before formatting. Unlike core Dear ImGui numeric widgets, ImPlot forwards the complete format to native printf paths, so this type also requires ASCII text. Use an axis formatter closure when localized or arbitrary UTF-8 output is required.

Implementations§

Source§

impl<'a> FloatFormat<'a>

Source

pub fn new(storage: impl Into<Cow<'a, str>>) -> Result<Self, FloatFormatError>

Validates a floating-point format accepted by ImPlot’s native formatters.

Source

pub fn as_str(&self) -> &str

Returns the validated format string.

Source

pub fn borrowed(&self) -> FloatFormat<'_>

Borrows this format without revalidating it.

Source

pub fn into_owned(self) -> FloatFormat<'static>

Converts this format into an owned value.

Source

pub fn into_numeric_format(self) -> NumericFormat<'a, f64>

Returns the underlying typed Dear ImGui numeric format.

Trait Implementations§

Source§

impl AsRef<str> for FloatFormat<'_>

Source§

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl<'a> Clone for FloatFormat<'a>

Source§

fn clone(&self) -> FloatFormat<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for FloatFormat<'a>

Source§

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

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

impl FromStr for FloatFormat<'static>

Source§

type Err = FloatFormatError

The associated error which can be returned from parsing.
Source§

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl<'a> PartialEq for FloatFormat<'a>

Source§

fn eq(&self, other: &FloatFormat<'a>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for FloatFormat<'a>

Source§

impl<'a> TryFrom<&'a str> for FloatFormat<'a>

Source§

type Error = FloatFormatError

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

fn try_from(value: &'a str) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl<'a> TryFrom<FloatFormat<'a>> for AxisFormat<'a>

Source§

type Error = AxisFormatError

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

fn try_from(format: FloatFormat<'a>) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<String> for FloatFormat<'static>

Source§

type Error = FloatFormatError

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

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

§

impl<'a> Freeze for FloatFormat<'a>

§

impl<'a> RefUnwindSafe for FloatFormat<'a>

§

impl<'a> Send for FloatFormat<'a>

§

impl<'a> Sync for FloatFormat<'a>

§

impl<'a> Unpin for FloatFormat<'a>

§

impl<'a> UnsafeUnpin for FloatFormat<'a>

§

impl<'a> UnwindSafe for FloatFormat<'a>

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§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

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>,

Source§

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.