Struct FloatRange 

pub struct FloatRange {
    pub min: Option<f64>,
    pub max: Option<f64>,
    pub min_open: bool,
    pub max_open: bool,
    pub clamp: bool,
}

A floating-point type restricted to a range of values.

If min or max are None, the range is unbounded in that direction. If clamp is true, out-of-range values are clamped to the boundary instead of producing an error. Note: clamping is not supported with open bounds.

Fields

min: Option<f64>

Minimum allowed value (inclusive unless min_open is true).

max: Option<f64>

Maximum allowed value (inclusive unless max_open is true).

min_open: bool

If true, the minimum bound is exclusive (value must be > min).

max_open: bool

If true, the maximum bound is exclusive (value must be < max).

clamp: bool

If true, clamp out-of-range values instead of failing. Not supported with open bounds.

Implementations

impl FloatRange

pub const fn new() -> Self

Create a new unbounded float range.

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

Set the minimum value (inclusive).

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

Set the maximum value (inclusive).

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

Set both minimum and maximum values.

pub fn min_open(self, open: bool) -> Self

Make the minimum bound exclusive (value must be > min).

Panics

Panics if clamping is enabled, as clamping is not supported for open bounds.

pub fn max_open(self, open: bool) -> Self

Make the maximum bound exclusive (value must be < max).

Panics

Panics if clamping is enabled, as clamping is not supported for open bounds.

pub fn clamp(self, clamp: bool) -> Self

Enable clamping of out-of-range values.

Panics

Panics if either bound is open, as clamping is not supported for open bounds.

Trait Implementations

impl Clone for FloatRange

fn clone(&self) -> FloatRange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FloatRange

impl Debug for FloatRange

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

Formats the value using the given formatter.

impl Default for FloatRange

fn default() -> Self

Returns the “default value” for a type.

impl TypeConverter for FloatRange

type Value = f64

The Rust type that this parameter type converts to.

fn name(&self) -> &str

Returns the descriptive name of this type (used in error messages).

fn convert(&self, value: &str) -> Result<Self::Value, String>

Convert a string value to the target type.

fn get_metavar(&self) -> Option<String>

Returns the metavar for this type (used in help text).

fn get_missing_message(&self) -> Option<String>

Returns an optional message when a required value is missing.

fn split_envvar_value(&self, value: &str) -> Vec<String>

Split an environment variable value into multiple values.

fn shell_complete(&self, _incomplete: &str) -> Vec<CompletionItem>

Returns shell completion items for the given incomplete value.

fn is_composite(&self) -> bool

Whether this type is a composite type (like Tuple).

fn arity(&self) -> usize

The arity (number of values consumed) for composite types.