Struct inquire::CustomType

pub struct CustomType<'a, T> {
    pub message: &'a str,
    pub default: Option<(T, CustomTypeFormatter<'a, T>)>,
    pub help_message: Option<&'a str>,
    pub formatter: CustomTypeFormatter<'a, T>,
    pub parser: CustomTypeParser<'a, T>,
    pub error_message: String,
}

Prompt to retrieve custom types automatically parsed from the user’s input.

Fields

message: &'a str

Message to be presented to the user.

default: Option<(T, CustomTypeFormatter<'a, T>)>

Default value, returned when the user input is empty.

help_message: Option<&'a str>

Help message to be presented to the user.

formatter: CustomTypeFormatter<'a, T>

Function that formats the user input and presents it to the user as the final rendering of the prompt.

parser: CustomTypeParser<'a, T>

Function that parses the user input and returns the result value.

error_message: String

Error message displayed when value could not be parsed from input.

Implementations

impl<'a, T> CustomType<'a, T> where
    T: Clone, 

pub fn new(message: &'a str) -> Self where
    T: FromStr + ToString, 

Creates a CustomType with the provided message and default configuration values.

pub fn with_default(self, default: (T, CustomTypeFormatter<'a, T>)) -> Self

Sets the default input.

pub fn with_help_message(self, message: &'a str) -> Self

Sets the help message of the prompt.

pub fn with_formatter(self, formatter: CustomTypeFormatter<'a, T>) -> Self

Sets the formatter

pub fn with_parser(self, parser: CustomTypeParser<'a, T>) -> Self

Sets the parser.

pub fn with_error_message(self, error_message: &'a str) -> Self

Sets a custom error message displayed when a submission could not be parsed to a value.

pub fn prompt(self) -> InquireResult<T>

Parses the provided behavioral and rendering options and prompts the CLI user for input according to the defined rules.

Trait Implementations

impl<'a, T: Clone> Clone for CustomType<'a, T>

fn clone(&self) -> CustomType<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> From<Confirm<'a>> for CustomType<'a, bool>

fn from(co: Confirm<'a>) -> Self

Performs the conversion.