Skip to main content

NumberSpec

Struct NumberSpec 

Source
#[non_exhaustive]
pub struct NumberSpec { pub min: Option<f64>, pub max: Option<f64>, pub step: f64, pub decimals: Option<u32>, }
Expand description

The rules of a number field (number_input): range, step, shown decimals. The value stays text while it is typed (-, 1. and an empty field are fine); the app reads it with NumberSpec::parse, the steppers and the arrow keys go through NumberSpec::stepped, and leaving the field tidies it with NumberSpec::normalized (uzor-framework’s kit::dom does all three).

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§min: Option<f64>

Smallest value (inclusive).

§max: Option<f64>

Largest value (inclusive).

§step: f64

One stepper / arrow-key step.

§decimals: Option<u32>

Decimals shown after a step or on leaving the field (None: as many as needed).

Implementations§

Source§

impl NumberSpec

Source

pub fn new() -> NumberSpec

Any number, step 1.

Source

pub fn integer() -> NumberSpec

Whole numbers only (no decimal point is typed), step 1.

Source

pub fn range(self, min: f64, max: f64) -> NumberSpec

The range min..=max.

Source

pub fn min(self, v: f64) -> NumberSpec

The smallest value.

Source

pub fn max(self, v: f64) -> NumberSpec

The largest value.

Source

pub fn step(self, v: f64) -> NumberSpec

One step.

Source

pub fn decimals(self, n: u32) -> NumberSpec

Decimals shown.

Source

pub fn accepts(&self, c: char) -> bool

Whether c may be typed: digits, a sign, a decimal point (. or ,) unless whole numbers only, and an exponent.

Source

pub fn sanitize(&self, text: &str) -> String

text with what may not be typed taken out (a paste of "1 234,5 $" → "1234,5").

Source

pub fn parse(&self, text: &str) -> Option<f64>

The value text holds, inside the range; None while it is not a number yet. A decimal comma reads as a point.

Source

pub fn clamp(&self, v: f64) -> f64

v inside the range.

Source

pub fn format(&self, v: f64) -> String

v as text: with NumberSpec::decimals places, else as short as it reads.

Source

pub fn stepped(&self, text: &str, n: i32) -> String

The text after n steps from text (an unreadable text steps from the range’s start, or 0), snapped to the step grid and clamped.

Source

pub fn normalized(&self, text: &str) -> String

The text tidied on leaving the field: the clamped value formatted, or the text unchanged when it is not a number (empty stays empty).

Trait Implementations§

Source§

impl Clone for NumberSpec

Source§

fn clone(&self) -> NumberSpec

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 Copy for NumberSpec

Source§

impl Debug for NumberSpec

Source§

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

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

impl Default for NumberSpec

Source§

fn default() -> NumberSpec

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

impl PartialEq for NumberSpec

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for NumberSpec

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§

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.