Enum ValidatorSpec 

#[non_exhaustive]
pub enum ValidatorSpec {
    NonEmpty,
    Regex(String),
    Predefined(String),
    Format {
        format: Format,
        min_length: Option<usize>,
        max_length: Option<usize>,
    },
}

Validator applied by the runtime to a typed response before it is accepted.

The rule is part of the prompt, so it is recorded with it: a transcript says a six-digit secret was entered, never which one. check is the one place a rule is applied, so rite check and the running ceremony agree on what a pattern accepts.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

NonEmpty

Reject empty or whitespace-only input.

Regex(String)

Input must match this regular expression in full.

Predefined(String)

Named, runtime-defined predicate (e.g. serial_number).

Format

A value of one Format, with a length within bounds.

What a PIN or a key component needs, stated without a pattern the person writing the ceremony has to get right. The length is counted in the format’s own units: characters for text, bytes for an encoding.

Fields

format: Format

What kind of value this is.

min_length: Option<usize>

Fewest units accepted, if bounded.

max_length: Option<usize>

Most units accepted, if bounded.

Implementations

impl ValidatorSpec

pub fn check(&self, value: &str) -> Result<(), String>

Apply the rule to a typed value.

Errors

Returns what the value fails to satisfy, worded for the person who typed it, or why the rule itself cannot be applied.

pub fn hint(&self) -> Option<String>

The rule as a person reads it before typing, if there is one worth stating.

NonEmpty says nothing: every prompt asks for something. A pattern is shown as written, since a regular expression has no better rendering.

Trait Implementations

impl Clone for ValidatorSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValidatorSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ValidatorSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ValidatorSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.