Struct rood::cli::output::OutputManager

pub struct OutputManager {
    pub verbose: bool,
    /* private fields */
}

The OutputManager is a nice wrapper over shell i/o functions.

It provides output nesting, various log levels and verbosity levels, as well as stack-like features for controlling more easily the indentation level of the output

Examples

Simple usage and stacked usage.

use rood::cli::OutputManager;

let verbose_mode = false;
let output = OutputManager::new(verbose_mode);
output.step("[Step 1]");
output.push().debug("Some indented verbose-only message");
output.success("[Step 1] - OK")

Using a Yes/No prompt and handling errors.

use rood::cli::OutputManager;

let output = OutputManager::new(false);
match output.prompt_yn("Really to quit?", false) {
    Ok(val) => output.success(&format!("User picked: {}", val)),
    Err(e) => output.error(&format!("Error: {}", e))
}

Fields

verbose: bool

Implementations

impl OutputManager

pub fn new(verbose: bool) -> OutputManager

Returns an OutputManager of the specified verbosity.

pub fn push(&self) -> OutputManager

Returns a new OutputManager with the same verbosity level, but with an indentation level incremented by one.

pub fn with_padding(&self, padding: i32) -> OutputManager

Returns a new OutputManager with the same verbosity level, but with an indentation level set to the level specified.

pub fn step<S: AsRef<str>>(&self, msg: S)

Displays a step. msg will be printed in yellow, prefixed by a +.

pub fn progress<S: AsRef<str>>(&self, msg: S)

Displays a progress message. ̀msg` will be printed in white without a prefix.

pub fn success<S: AsRef<str>>(&self, msg: S)

Displays a success message. msg will be printed in green, prefixed by a ‘+’.

pub fn debug<S: AsRef<str>>(&self, msg: S)

Displays a debug message. msg will be printed in blue, prefixed by a ‘-’. Note: Debug messages are only printed when the verbose flag is set.

pub fn error<S: AsRef<str>>(&self, msg: S)

Displays an error message. msg will be printed in red, prefixed by a ‘!’.

pub fn prompt<S: AsRef<str>>(&self, msg: S) -> Result<String>

Displays a prompt. msg will be printed in blue, prefixed by a ‘?’. Will wait for user input before returning what the user typed.

pub fn prompt_yn<S: AsRef<str>>(&self, msg: S, default: bool) -> Result<bool>

Displays a yes/no prompt. msg will be printed in blue, prefixed by a ‘?’. Will wait for user input before returning what the user selected.

pub fn prompt_password<S: AsRef<str>>(&self, msg: S) -> Result<String>

Displays a prompt for a password or any sensitive information. msg will be printed in blue, prefixed by a ‘?’. Will wait for user input before returning what the user typed.

pub fn clear(&self) -> Result<()>

Trait Implementations

impl Clone for OutputManager

fn clone(&self) -> OutputManager

Returns a copy of the value.

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

Performs copy-assignment from source.