Definitions of inquire’s error handling

Type aliases and default implementations for functions called as formatters of a given input.

Utilities used to wrap user selections in Select and MultiSelect prompts.

Type aliases and default implementations for parsers called in prompts that need to parse user input, such as Confirm or CustomType.

progress

type_aliases

General type aliases.

ui

UI-related definitions for rendered content.

validator

Type aliases for functions used by prompts to validate user input before returning the values to their callers.

Macros

length

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

max_length

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

min_length

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

parse_type

Built-in parser creator that checks whether the answer is able to be successfully parsed to a given type, such as f64. The given type must implement the FromStr trait.

required

Built-in validator that checks whether the answer is not empty.

Structs

Confirm

Prompt to ask the user for simple yes/no questions, commonly known by asking the user displaying the (y/n) text.

CustomType

Generic prompt suitable for when you need to parse the user input into a specific type, for example an f64 or a rust_decimal, maybe even an uuid.

MultiSelect

Prompt suitable for when you need the user to select many options (including none if applicable) among a list of them.

Password

Prompt meant for secretive text inputs.

Select

Prompt suitable for when you need the user to select one option among many.

Text

Standard text prompt that returns the user string input.