Struct inquire::validator::ExactLengthValidator

pub struct ExactLengthValidator { /* private fields */ }

Built-in validator that checks whether the answer length is equal to the specified value.

The validator uses a custom-built length function that has a special implementation for strings which counts the number of graphemes. See this StackOverflow question.

Examples

use inquire::validator::{ExactLengthValidator, StringValidator, Validation};

let validator = ExactLengthValidator::new(3);
assert_eq!(Validation::Valid, validator.validate("Yes")?);
assert_eq!(
    Validation::Invalid("The length of the response should be 3".into()),
    validator.validate("No")?,
);

let validator = ExactLengthValidator::new(3).with_message("Three characters please.");
assert_eq!(Validation::Valid, validator.validate("Yes")?);
assert_eq!(Validation::Invalid("Three characters please.".into()), validator.validate("No")?);

Implementations

impl ExactLengthValidator

pub fn new(length: usize) -> Self

Create a new instance of this validator, requiring exactly the given length, otherwise returning an error with default message.

pub fn with_message(self, message: impl Into<String>) -> Self

Define a custom error message returned by the validator. Defaults to The length of the response should be $length.

Trait Implementations

impl Clone for ExactLengthValidator

fn clone(&self) -> ExactLengthValidator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: ?Sized> MultiOptionValidator<T> for ExactLengthValidator

fn validate( &self, input: &[ListOption<&T>] ) -> Result<Validation, CustomUserError>

Confirm the given input list is a valid value.

impl StringValidator for ExactLengthValidator

fn validate(&self, input: &str) -> Result<Validation, CustomUserError>

Confirm the given input string is a valid value.