Skip to main content

PromptMode

Enum PromptMode 

Source
#[non_exhaustive]
pub enum PromptMode { Interactive, NonInteractive, }
Expand description

How the prompter sources answers, resolved once up front.

The decision models interactive stdio: prompts are read from stdin but rendered to stderr, so a session is only interactive when both streams are terminals. If stderr is redirected (cmd 2>log) the user would never see the question, so the mode falls back to NonInteractive even when stdin is a TTY.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

Interactive

Interactive stdio (both stdin and stderr are terminals): render prompts and read live, typed answers.

§

NonInteractive

Non-interactive stdio (CI, piped, or a redirected prompt sink): never block; resolve each question to its declared default.

Implementations§

Source§

impl PromptMode

Source

pub fn from_env() -> Self

Resolve the mode from the current process’s stdin and stderr TTY status.

Source

pub const fn from_stdio(stdin_is_tty: bool, stderr_is_tty: bool) -> Self

Resolve the mode from already-known stream TTY statuses (env-free, testable).

Interactive only when both the input (stdin) and the prompt sink (stderr) are terminals, so a redirected sink never leaves the user blocked behind an invisible prompt.

Source

pub const fn is_interactive(self) -> bool

Whether this mode reads live answers.

Trait Implementations§

Source§

impl Clone for PromptMode

Source§

fn clone(&self) -> PromptMode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for PromptMode

Source§

impl Debug for PromptMode

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for PromptMode

Source§

impl PartialEq for PromptMode

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PromptMode

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> 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.