Struct NumberInputState 

pub struct NumberInputState { /* private fields */ }

State for a NumberInput component.

Implementations

impl NumberInputState

pub fn new(value: f64) -> Self

Creates a new number input with the given initial value.

Defaults to step 1.0 and precision 0 (integer display).

Example

use envision::component::NumberInputState;

let state = NumberInputState::new(42.0);
assert_eq!(state.value(), 42.0);
assert_eq!(state.format_value(), "42");

pub fn integer(value: i64) -> Self

Creates a new number input configured for integer values.

Convenience constructor that sets precision to 0 and step to 1.0.

Example

use envision::component::NumberInputState;

let state = NumberInputState::integer(42);
assert_eq!(state.value(), 42.0);
assert_eq!(state.format_value(), "42");

pub fn with_min(self, min: f64) -> Self

Sets the minimum bound (builder pattern).

Example

use envision::component::NumberInputState;

let state = NumberInputState::new(5.0).with_min(0.0);

pub fn with_max(self, max: f64) -> Self

Sets the maximum bound (builder pattern).

Example

use envision::component::NumberInputState;

let state = NumberInputState::new(5.0).with_max(10.0);

pub fn with_range(self, min: f64, max: f64) -> Self

Sets both minimum and maximum bounds (builder pattern).

Example

use envision::component::NumberInputState;

let state = NumberInputState::new(5.0).with_range(0.0, 10.0);

pub fn with_step(self, step: f64) -> Self

Sets the step size (builder pattern).

Example

use envision::component::NumberInputState;

let state = NumberInputState::new(0.0).with_step(0.5);

pub fn with_precision(self, precision: usize) -> Self

Sets the decimal precision (builder pattern).

Example

use envision::component::NumberInputState;

let state = NumberInputState::new(3.75).with_precision(2);
assert_eq!(state.format_value(), "3.75");

pub fn with_label(self, label: impl Into<String>) -> Self

Sets the label (builder pattern).

Example

use envision::component::NumberInputState;

let state = NumberInputState::new(0.0).with_label("Quantity");
assert_eq!(state.label(), Some("Quantity"));

pub fn with_placeholder(self, placeholder: impl Into<String>) -> Self

Sets the placeholder text (builder pattern).

Example

use envision::component::NumberInputState;

let state = NumberInputState::new(0.0).with_placeholder("Enter value...");

pub fn value(&self) -> f64

Returns the current numeric value.

Example

use envision::component::NumberInputState;

let state = NumberInputState::new(42.0);
assert_eq!(state.value(), 42.0);

pub fn set_value(&mut self, value: f64)

Sets the current value, clamping to any configured bounds.

Example

use envision::component::NumberInputState;

let mut state = NumberInputState::new(0.0).with_range(0.0, 100.0);
state.set_value(50.0);
assert_eq!(state.value(), 50.0);

state.set_value(200.0);
assert_eq!(state.value(), 100.0);

pub fn is_editing(&self) -> bool

Returns true if the component is in text edit mode.

pub fn edit_buffer(&self) -> &str

Returns the current edit buffer contents.

pub fn label(&self) -> Option<&str>

Returns the label, if set.

pub fn placeholder(&self) -> Option<&str>

Returns the placeholder, if set.

pub fn set_placeholder(&mut self, placeholder: impl Into<String>)

Sets the placeholder text.

Example

use envision::component::NumberInputState;

let mut state = NumberInputState::new(0.0);
state.set_placeholder("Enter a number...");
assert_eq!(state.placeholder(), Some("Enter a number..."));

pub fn step(&self) -> f64

Returns the step size.

pub fn precision(&self) -> usize

Returns the precision (decimal places).

pub fn min(&self) -> Option<f64>

Returns the minimum bound, if set.

pub fn max(&self) -> Option<f64>

Returns the maximum bound, if set.

pub fn format_value(&self) -> String

Formats the current value according to the configured precision.

Example

use envision::component::NumberInputState;

let state = NumberInputState::new(42.0);
assert_eq!(state.format_value(), "42");

let state = NumberInputState::new(3.75).with_precision(2);
assert_eq!(state.format_value(), "3.75");

pub fn update(&mut self, msg: NumberInputMessage) -> Option<NumberInputOutput>

Updates the number input state with a message, returning any output.

Example

use envision::component::{NumberInputMessage, NumberInputOutput, NumberInputState};

let mut state = NumberInputState::new(10.0);
let output = state.update(NumberInputMessage::Increment);
assert_eq!(output, Some(NumberInputOutput::ValueChanged(11.0)));
assert_eq!(state.value(), 11.0);

Trait Implementations

impl Clone for NumberInputState

fn clone(&self) -> NumberInputState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NumberInputState

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

Formats the value using the given formatter.

impl Default for NumberInputState

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NumberInputState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for NumberInputState

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for NumberInputState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for NumberInputState