Enum PromptUserError 

#[non_exhaustive]
pub enum PromptUserError {
    #[non_exhaustive]
    AbsentUser {
        question: String,
    },
    #[non_exhaustive]
    CancelledPrompt {
        question: String,
    },
    #[non_exhaustive]
    MissingOptions {
        question: String,
    },
    #[non_exhaustive]
    UnansweredPrompt {
        question: String,
        source: AnswerPromptError,
    },
    #[non_exhaustive]
    UnknownOption {
        question: String,
        index: usize,
        count: usize,
    },
    #[non_exhaustive]
    UndeliverablePrompt {
        question: String,
        source: SendError,
    },
}

The error returned when a command cannot get an answer from its user

No variant is an answer, so a command must not treat one as a yes, a no, or a default. Every variant carries the text of the question.

A later release can add variants, and it can add fields to a variant. Match with a wildcard arm, and bind the fields of a variant with ...

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.

#[non_exhaustive]

AbsentUser

No user is present who can answer

The Interactivity of the prompt is NonInteractive. The prompt sends no request.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

question: String

The text of the question

#[non_exhaustive]

CancelledPrompt

Cancellation stopped the prompt before the user answered

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

question: String

The text of the question

#[non_exhaustive]

MissingOptions

The command asked the user to select from no options

The prompt sends no request.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

question: String

The text of the question

#[non_exhaustive]

UnansweredPrompt

The presenter returned no answer

The source is the reason.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

question: String

The text of the question

source: AnswerPromptError

The cause of the failure

#[non_exhaustive]

UnknownOption

The answer names an option that the prompt does not have

The presenter sent a position beyond the options. The cause is a fault in the presenter, or a script of a test that does not match the question.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

question: String

The text of the question

index: usize

The position that the answer names, where the first option has the position zero

count: usize

The count of the options that the prompt has

#[non_exhaustive]

UndeliverablePrompt

The prompt could not be sent to the presenter

The event channel is closed.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

question: String

The text of the question

source: SendError

The cause of the failure

Trait Implementations

impl Debug for PromptUserError

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

Formats the value using the given formatter.

impl Display for PromptUserError

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

Formats the value using the given formatter.

impl Error for PromptUserError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.