Struct ByteSize 

pub struct ByteSize { /* private fields */ }

(bytesize feature) Accepts a human byte-size string (e.g. "10MB", "1GiB") and coerces it to an integer number of bytes.

Implementations

impl ByteSize

pub fn new() -> Self

pub fn with_meta(self, meta: Meta) -> Self

Attach human-facing metadata (name, description, examples, default, output conversion).

impl ByteSize

pub fn name(&self) -> &str

The human-readable name.

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

The description, if any.

pub fn examples(&self) -> &[(Value, Option<String>)]

The example values (each with an optional note).

pub fn default_value(&self) -> Option<&Value>

The default value, if any.

pub fn convert(&self) -> Option<ValueType>

The output conversion target, if any.

pub fn with_name(self, name: impl Into<String>) -> Self

Set the human-readable name (surfaced in error messages).

pub fn with_description(self, text: impl Into<String>) -> Self

Attach a human-readable description.

pub fn with_example(self, value: impl Into<Value>) -> Self

Add an example value.

pub fn with_example_noted( self, value: impl Into<Value>, note: impl Into<String>, ) -> Self

Add an example value with an explanatory note.

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).

pub fn to_string(self) -> Self

After validation succeeds, cast the value to a string.

pub fn to_int(self) -> Self

After validation succeeds, cast the value to an integer.

pub fn to_float(self) -> Self

After validation succeeds, cast the value to a float.

pub fn to_bool(self) -> Self

After validation succeeds, cast the value to a boolean.

Trait Implementations

impl Clone for ByteSize

fn clone(&self) -> ByteSize

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ByteSize

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

Formats the value using the given formatter.

impl Default for ByteSize

fn default() -> ByteSize

Returns the “default value” for a type.

impl Validator for ByteSize

fn meta(&self) -> &Meta

This validator’s human-facing metadata.

fn meta_mut(&mut self) -> &mut Meta

Mutable access to this validator’s metadata (backs the builder setters).

fn check(&self, value: &mut Value) -> Result<(), Error>

The validation rule: check (and coerce) value in place.

fn validate(&self, value: &mut Value) -> Result<(), Error>

Run check; on error attach this validator’s Meta (innermost wins); on success apply the output conversion in meta().convert, if any.