Struct Promptuity

pub struct Promptuity<'a, W: Write> { /* private fields */ }

The core struct of promptuity.

Examples

Basic

use promptuity::themes::MinimalTheme;
use promptuity::prompts::{Input, Confirm};
use promptuity::{Promptuity, Term};

let mut term = Term::default();
let mut theme = MinimalTheme::default();
let mut p = Promptuity::new(&mut term, &mut theme);

p.begin()?;

let name = p.prompt(Input::new("Please enter your username").with_placeholder("username"))?;
let full = p.prompt(Confirm::new("Are you a full-time software developer?").with_default(true))?;

p.finish()?;

Logging

Executing begin activates Raw Mode. Since log outputs like println! will no longer render correctly, if you need to output logs, please use log methods such as Promptuity::log or Promptuity::warn.

p.begin()?;

p.step("Logging Step")?;
p.log("This is a log message")?;
p.info("This is a info message")?;
p.warn("This is a warn message")?;
p.error("This is a error message")?;
p.success("This is a success message")?;

p.finish()?;

Implementations

impl<'a, W: Write> Promptuity<'a, W>

pub fn new(term: &'a mut dyn Terminal<W>, theme: &'a mut dyn Theme<W>) -> Self

Creates a new Promptuity instance.

pub fn term(&mut self) -> &mut dyn Terminal<W>

Returns the currently used terminal.

pub fn with_intro(&mut self, intro: impl Display) -> &mut Self

Sets the intro message for the prompt session.
May be required by the Theme.

pub fn with_outro(&mut self, outro: impl Display) -> &mut Self

Sets the outro message for the prompt session. May be required by the Theme.

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

Declares the start of a prompt session.
Executing begin activates Raw Mode. Since log outputs like println! will no longer render correctly, if you need to output logs, please use log methods such as Promptuity::log or Promptuity::warn.

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

Declares the end of a prompt session.
Executing finish deactivates Raw Mode.

pub fn step(&mut self, message: impl Display) -> Result<(), Error>

Displays a message as a prompt step.

pub fn log(&mut self, message: impl Display) -> Result<(), Error>

Output of messages without decoration.

pub fn info(&mut self, message: impl Display) -> Result<(), Error>

Output of messages with info decoration.

pub fn warn(&mut self, message: impl Display) -> Result<(), Error>

Output of messages with warning decoration.

pub fn error(&mut self, message: impl Display) -> Result<(), Error>

Output of messages with error decoration.

pub fn success(&mut self, message: impl Display) -> Result<(), Error>

Output of messages with success decoration.

pub fn prompt<O>( &mut self, prompt: &mut dyn Prompt<Output = O>, ) -> Result<O, Error>

Executes the specified prompt and returns the input result.

Trait Implementations

impl<'a, W: Write> Drop for Promptuity<'a, W>

fn drop(&mut self)

Executes the destructor for this type.