Struct cargo_component_core::terminal::Terminal

pub struct Terminal(/* private fields */);

An abstraction around output that considers preferences for verbosity and color.

This is based off of the cargo implementation.

Implementations

impl Terminal

pub fn new(verbosity: Verbosity, color: Color) -> Self

Creates a new terminal with the given verbosity and color.

pub fn from_write(out: Box<dyn Write>) -> Self

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

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

Prints a green ‘status’ message.

pub fn status_with_color<T, U>( &self, status: T, message: U, color: AnsiColors ) -> Result<()>where T: Display, U: Display,

Prints a ‘status’ message with the specified color.

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

Prints a cyan ‘note’ message.

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

Prints a yellow ‘warning’ message.

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

Prints a red ‘error’ message.

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

Write a styled fragment to stdout.

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

pub fn width(&self) -> Option<usize>

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

pub fn verbosity(&self) -> Verbosity

Returns the verbosity of the terminal.

Trait Implementations

impl Debug for Terminal

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

Formats the value using the given formatter.