Struct Shell

pub struct Shell { /* private fields */ }

An abstraction around console output that remembers preferences for output verbosity and color.

Implementations

impl Shell

pub fn new() -> Shell

Creates a new shell (color choice and verbosity), defaulting to ‘auto’ color and verbose output.

pub fn from_write(out: Box<dyn Write + Send + Sync>) -> Shell

Creates a shell from a plain writable object, with no color, and max verbosity.

pub fn set_needs_clear(&mut self, needs_clear: bool)

Sets whether the next print should clear the current line.

pub fn is_cleared(&self) -> bool

Returns true if the needs_clear flag is unset.

pub fn err_width(&self) -> TtyWidth

Returns the width of the terminal in spaces, if any.

pub fn is_err_tty(&self) -> bool

Returns true if stderr is a tty.

pub fn out(&mut self) -> &mut dyn Write

Gets a reference to the underlying stdout writer.

pub fn err(&mut self) -> &mut dyn Write

Gets a reference to the underlying stderr writer.

pub fn err_erase_line(&mut self)

Erase from cursor to end of line.

pub fn status<T, U>(&mut self, status: T, message: U) -> Result<()>

where T: Display, U: Display,

Shortcut to right-align and color green a status message.

pub fn status_header<T>(&mut self, status: T) -> Result<()>

where T: Display,

pub fn status_with_color<T, U>( &mut self, status: T, message: U, color: &Style, ) -> Result<()>

where T: Display, U: Display,

Shortcut to right-align a status message.

pub fn verbose<F>(&mut self, callback: F) -> Result<()>

where F: FnMut(&mut Shell) -> Result<()>,

Runs the callback only if we are in verbose mode.

pub fn concise<F>(&mut self, callback: F) -> Result<()>

where F: FnMut(&mut Shell) -> Result<()>,

Runs the callback if we are not in verbose mode.

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

Prints a red ‘error’ message.

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

Prints an amber ‘warning’ message.

pub fn note<T: Display>(&mut self, message: T) -> Result<()>

Prints a cyan ‘note’ message.

pub fn set_verbosity(&mut self, verbosity: Verbosity)

Updates the verbosity of the shell.

pub fn verbosity(&self) -> Verbosity

Gets the verbosity of the shell.

pub fn set_color_choice(&mut self, color: Option<&str>) -> Result<()>

Updates the color choice (always, never, or auto) from a string..

pub fn set_hyperlinks(&mut self, yes: bool) -> Result<()>

pub fn color_choice(&self) -> ColorChoice

Gets the current color choice.

If we are not using a color stream, this will always return Never, even if the color choice has been set to something else.

pub fn err_supports_color(&self) -> bool

Whether the shell supports color.

pub fn out_supports_color(&self) -> bool

pub fn out_hyperlink<D: Display>(&self, url: D) -> Hyperlink<D>

pub fn err_hyperlink<D: Display>(&self, url: D) -> Hyperlink<D>

pub fn out_file_hyperlink(&mut self, path: &Path) -> Hyperlink<Url>

pub fn err_file_hyperlink(&mut self, path: &Path) -> Hyperlink<Url>

pub fn print_ansi_stderr(&mut self, message: &[u8]) -> Result<()>

Prints a message to stderr and translates ANSI escape code into console colors.

pub fn print_ansi_stdout(&mut self, message: &[u8]) -> Result<()>

Prints a message to stdout and translates ANSI escape code into console colors.

pub fn print_json<T: Serialize>(&mut self, obj: &T) -> Result<()>

Trait Implementations

impl Debug for Shell

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

Formats the value using the given formatter.

impl Default for Shell

fn default() -> Self

Returns the “default value” for a type.