Struct Shell

pub struct Shell {
    output: ShellOut,
    output_format: OutputFormat,
    output_mode: OutputMode,
    verbosity: Verbosity,
    needs_clear: AtomicBool,
}

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

Fields

output: ShellOut

Wrapper around stdout/stderr. This helps with supporting sending output to a memory buffer which is useful for tests.

output_format: OutputFormat

The format to use for message output.

output_mode: OutputMode

The verbosity mode to use for message output.

verbosity: Verbosity

The verbosity level to use for message output.

needs_clear: AtomicBool

Flag that indicates the current line needs to be cleared before printing. Used when a progress bar is currently displayed.

Implementations

impl Shell

pub fn new() -> Self

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

pub fn new_with( format: OutputFormat, mode: OutputMode, color: ColorChoice, verbosity: Verbosity, ) -> Self

Creates a new shell with the given color choice and verbosity.

pub fn empty() -> Self

Creates a shell that ignores all output.

pub fn get() -> impl DerefMut<Target = Self> + 'static

Acquire a lock to the global shell.

Initializes it with the default values if it has not been set yet.

pub fn set(self)

Set the global shell.

Panics

Panics if the global shell has already been set.

pub fn set_needs_clear(&self, needs_clear: bool) -> bool

Sets whether the next print should clear the current line and returns the previous value.

pub fn is_json(&self) -> bool

Returns true if the output format is JSON.

pub fn is_quiet(&self) -> bool

Returns true if the verbosity level is Quiet.

pub fn needs_clear(&self) -> bool

Returns true if the needs_clear flag is set.

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 output_format(&self) -> OutputFormat

Gets the output format of the shell.

pub fn output_mode(&self) -> OutputMode

Gets the output mode of the shell.

pub fn verbosity(&self) -> Verbosity

Gets the verbosity of the shell when OutputMode::Normal is set.

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

Sets the verbosity level.

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 is_err_tty(&self) -> bool

Returns true if stderr is a tty.

pub fn err_supports_color(&self) -> bool

Whether stderr supports color.

pub fn out_supports_color(&self) -> bool

Whether stdout supports color.

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 maybe_err_erase_line(&mut self)

Erase from cursor to end of line if needed.

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

Prints a red ‘error’ message. Use the sh_err! macro instead. This will render a message in ERROR style with a bold Error: prefix.

Note: will log regardless of the verbosity level.

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

Prints an amber ‘warning’ message. Use the sh_warn! macro instead. This will render a message in WARN style with a bold Warning: prefix.

Note: if verbosity is set to Quiet, this is a no-op.

pub fn write_stdout( &mut self, fragment: impl Display, color: &Style, ) -> Result<()>

Write a styled fragment.

Caller is responsible for deciding whether Shell::verbosity is affects output.

pub fn print_out(&mut self, fragment: impl Display) -> Result<()>

Write a styled fragment with the default color. Use the sh_print! macro instead.

Note: if verbosity is set to Quiet, this is a no-op.

pub fn write_stderr( &mut self, fragment: impl Display, color: &Style, ) -> Result<()>

Write a styled fragment

Caller is responsible for deciding whether Shell::verbosity is affects output.

pub fn print_err(&mut self, fragment: impl Display) -> Result<()>

Write a styled fragment with the default color. Use the sh_eprint! macro instead.

Note: if verbosity is set to Quiet, this is a no-op.

fn print( &mut self, status: &dyn Display, style: &Style, message: Option<&dyn Display>, justified: bool, ) -> Result<()>

Prints a message, where the status will have color color, and can be justified. The messages follows without color.

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.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 64 bytes