pub struct Float { /* private fields */ }Expand description
(float feature) Accepts a float, with optional inclusive bounds and lenient coercion.
Coercion:
- a float stays as-is;
- an integer becomes a float (
7→7.0); - a string is parsed as a float (which also accepts integer-looking strings).
Implementations§
Source§impl Float
impl Float
Sourcepub fn with_meta(self, meta: Meta) -> Self
pub fn with_meta(self, meta: Meta) -> Self
Attach human-facing metadata (name, description, examples, default, output conversion).
pub fn new() -> Self
pub fn min(self, min: f64) -> Self
pub fn max(self, max: f64) -> Self
pub fn range(self, start: f64, end: f64) -> Self
Sourcepub fn non_negative(self) -> Self
pub fn non_negative(self) -> Self
Require the value to be greater than or equal to zero.
Sourcepub fn non_positive(self) -> Self
pub fn non_positive(self) -> Self
Require the value to be less than or equal to zero.
Source§impl Float
impl Float
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description, if any.
Sourcepub fn examples(&self) -> &[(Value, Option<String>)]
pub fn examples(&self) -> &[(Value, Option<String>)]
The example values (each with an optional note).
Sourcepub fn default_value(&self) -> Option<&Value>
pub fn default_value(&self) -> Option<&Value>
The default value, if any.
Sourcepub fn with_name(self, name: impl Into<String>) -> Self
pub fn with_name(self, name: impl Into<String>) -> Self
Set the human-readable name (surfaced in error messages).
Sourcepub fn with_description(self, text: impl Into<String>) -> Self
pub fn with_description(self, text: impl Into<String>) -> Self
Attach a human-readable description.
Sourcepub fn with_example(self, value: impl Into<Value>) -> Self
pub fn with_example(self, value: impl Into<Value>) -> Self
Add an example value.
Sourcepub fn with_example_noted(
self,
value: impl Into<Value>,
note: impl Into<String>,
) -> Self
pub fn with_example_noted( self, value: impl Into<Value>, note: impl Into<String>, ) -> Self
Add an example value with an explanatory note.
Sourcepub fn with_default(self, value: impl Into<Value>) -> Self
pub fn with_default(self, value: impl Into<Value>) -> Self
Set the default value used as an on-error fallback (see the pipeline’s validate stage).
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Float
impl RefUnwindSafe for Float
impl Send for Float
impl Sync for Float
impl Unpin for Float
impl UnsafeUnpin for Float
impl UnwindSafe for Float
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more