Struct inquire::validator::MaxLengthValidator

pub struct MaxLengthValidator { /* private fields */ }

Built-in validator that checks whether the answer length is smaller than or equal to the specified threshold.

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::{MaxLengthValidator, StringValidator, Validation};

let validator = MaxLengthValidator::new(5);
assert_eq!(Validation::Valid, validator.validate("Good")?);
assert_eq!(
    Validation::Invalid("The length of the response should be at most 5".into()),
    validator.validate("Terrible")?,
);

let validator = MaxLengthValidator::new(5).with_message("Not too large!");
assert_eq!(Validation::Valid, validator.validate("Good")?);
assert_eq!(Validation::Invalid("Not too large!".into()), validator.validate("Terrible")?);

Implementations

impl MaxLengthValidator

pub fn new(limit: usize) -> Self

Create a new instance of this validator, requiring at most 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 at most $length.

Trait Implementations

impl Clone for MaxLengthValidator

fn clone(&self) -> MaxLengthValidator

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Confirm the given input list is a valid value.

impl StringValidator for MaxLengthValidator

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

Confirm the given input string is a valid value.