Struct Ui 

pub struct Ui { /* private fields */ }

An abstraction around console output which stores preferences for output format (human vs JSON), colour, etc.

All human-oriented messaging (basically all writes to stdout) must go through this object.

Implementations

impl Ui

pub fn new(verbosity: Verbosity, output_format: OutputFormat) -> Self

Create a new Ui instance configured with the given verbosity and output format.

pub fn verbosity(&self) -> Verbosity

Get the verbosity level of this Ui instance.

pub fn output_format(&self) -> OutputFormat

Get the output format of this Ui instance.

pub fn print<T: Message>(&self, message: T)

Print the message to standard output if not in quiet verbosity mode.

pub fn force_print<T: Message>(&self, message: T)

Print the message to standard output regardless of the verbosity mode.

pub fn verbose<T: Message>(&self, message: T)

Print the message to the standard output only in verbose mode.

pub fn widget<T: Widget>(&self, widget: T) -> Option<T::Handle>

Display an interactive widget and return a handle for further interaction.

The widget will be only displayed if not in quiet mode, and if the output format is text.

pub fn warn(&self, message: impl AsRef<str>)

Print a warning to the user.

pub fn error(&self, message: impl AsRef<str>)

Print an error to the user.

pub fn warn_with_code(&self, code: impl AsRef<str>, message: impl AsRef<str>)

Print a warning to the user.

pub fn error_with_code(&self, code: impl AsRef<str>, message: impl AsRef<str>)

Print an error to the user.

pub fn anyhow(&self, error: &Error)

Nicely format an anyhow::Error for display to the user, and print it with Ui::error.

pub fn warn_anyhow(&self, error: &Error)

Nicely format an anyhow::Error for display to the user, and print it with Ui::warn.

pub fn force_colors_enabled(&self, enable: bool)

Forces colorization on or off for stdout.

This overrides the default for the current process and changes the return value of the Ui::has_colors_enabled function.

pub fn has_colors_enabled(&self) -> bool

Returns true if colors should be enabled for stdout.

This honors the clicolors spec.

• CLICOLOR != 0: ANSI colors are supported and should be used when the program isn’t piped.
• CLICOLOR == 0: Don’t output ANSI color escape codes.
• CLICOLOR_FORCE != 0: ANSI colors should be enabled no matter what.

pub fn force_colors_enabled_stderr(&self, enable: bool)

Forces colorization on or off for stdout.

This overrides the default for the current process and changes the return value of the Ui::has_colors_enabled function.

pub fn has_colors_enabled_stderr(&self) -> bool

Returns true if colors should be enabled for stderr.

This honors the clicolors spec.

• CLICOLOR != 0: ANSI colors are supported and should be used when the program isn’t piped.
• CLICOLOR == 0: Don’t output ANSI color escape codes.
• CLICOLOR_FORCE != 0: ANSI colors should be enabled no matter what.

Trait Implementations

impl Clone for Ui

fn clone(&self) -> Ui

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ui

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

Formats the value using the given formatter.