Struct Boolean 

pub struct Boolean { /* private fields */ }

Implementations

impl Boolean

pub fn new(message: String) -> Self

pub fn with_formatter( &mut self, formatter: impl ConfirmFormatter + 'static, ) -> &mut Self

pub fn with_hint(&mut self, hint: impl Display) -> &mut Self

pub fn with_default(&mut self, value: bool) -> &mut Self

Trait Implementations

impl Prompt for Boolean

type Output = Value

The type returned as a result by the prompt.

fn setup(&mut self) -> Result<(), Error>

Sets up the prompt.
A lifecycle method for validating and initializing settings.

fn handle(&mut self, code: KeyCode, modifiers: KeyModifiers) -> PromptState

Handles key presses.
Allows changing the internal state of the prompt in response to key inputs.

fn submit(&mut self) -> Self::Output

Submits the prompt.
Called as a result of Prompt::handle returning PromptState::Submit, it returns the final value.

fn render(&mut self, state: &PromptState) -> Result<RenderPayload, String>

Renders the prompt.
Performs rendering based on the value of PromptState.
If returning an error, please return the error message as a String.

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

Validates the prompt.
If returning an error, please return the error message as a String.