Enum Confirmation 

pub enum Confirmation {
    TypeToken {
        message: &'static str,
        token: &'static str,
    },
    YesNo {
        message: &'static str,
    },
}

Pre-invocation confirmation gate.

Declared in the command manifest and checked by the CLI dispatch layer before the handler runs. Has no effect on HTTP endpoints - the API is not interactive.

Variants

TypeToken

Prompt the user to type an exact token (e.g. "RESET").

The message is printed to stderr first, then the user is asked to type token. Any other input aborts.

Fields

message: &'static str

token: &'static str

YesNo

Simple yes/no prompt. The message is shown, and the user must type y or yes (case-insensitive) to proceed.

Fields

message: &'static str

Implementations

impl Confirmation

pub fn prompt<R: BufRead, W: Write>( &self, reader: &mut R, writer: &mut W, ) -> Result<bool>

Run the confirmation prompt on the given reader/writer pair.

Returns Ok(true) if the user confirmed, Ok(false) if they declined, and Err on I/O failure.

pub fn prompt_stdio(&self) -> Result<bool>

Convenience: prompt on real stdin/stderr.

Trait Implementations

impl Clone for Confirmation

fn clone(&self) -> Confirmation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Confirmation

impl Debug for Confirmation

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

Formats the value using the given formatter.

impl Eq for Confirmation

impl PartialEq for Confirmation

fn eq(&self, other: &Confirmation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Confirmation