Skip to main content

ConfirmPromptSource

Struct ConfirmPromptSource 

Source
pub struct ConfirmPromptSource<T: TerminalIO = RealTerminal> { /* private fields */ }
Expand description

Simple yes/no confirmation prompt.

Prompts the user for a yes/no response. Accepts y/yes/n/no (case-insensitive).

§Example

use standout_input::{InputChain, FlagSource, ConfirmPromptSource};

let chain = InputChain::<bool>::new()
    .try_source(FlagSource::new("yes"))
    .try_source(ConfirmPromptSource::new("Proceed?"));

let confirmed = chain.resolve(&matches)?;

Implementations§

Source§

impl ConfirmPromptSource<RealTerminal>

Source

pub fn new(prompt: impl Into<String>) -> Self

Create a new confirmation prompt.

Source§

impl<T: TerminalIO> ConfirmPromptSource<T>

Source

pub fn with_terminal(prompt: impl Into<String>, terminal: T) -> Self

Create a confirm prompt with a custom terminal for testing.

Source

pub fn default(self, default: bool) -> Self

Set a default value for when the user presses Enter without input.

The prompt suffix will change to indicate the default:

  • None: [y/n]
  • Some(true): [Y/n]
  • Some(false): [y/N]

Trait Implementations§

Source§

impl<T: Clone + TerminalIO> Clone for ConfirmPromptSource<T>

Source§

fn clone(&self) -> ConfirmPromptSource<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: TerminalIO + 'static> InputCollector<bool> for ConfirmPromptSource<T>

Source§

fn name(&self) -> &'static str

Human-readable name for this collector. Read more
Source§

fn is_available(&self, _matches: &ArgMatches) -> bool

Check if this collector can provide input in the current environment. Read more
Source§

fn collect(&self, _matches: &ArgMatches) -> Result<Option<bool>, InputError>

Attempt to collect input from this source. Read more
Source§

fn can_retry(&self) -> bool

Whether this collector supports retry on validation failure. Read more
Source§

fn validate(&self, _value: &T) -> Result<(), String>

Validate the collected value. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.