Struct Ui

pub struct Ui { /* private fields */ }

Implementations

impl Ui

pub fn null() -> Ui

pub fn with_config(config: &StackedConfig) -> Result<Ui, CommandError>

pub fn reset(&mut self, config: &StackedConfig) -> Result<(), CommandError>

pub fn request_pager(&mut self)

Switches the output to use the pager, if allowed.

pub fn color(&self) -> bool

pub fn new_formatter<'output, W: Write + 'output>( &self, output: W, ) -> Box<dyn Formatter + 'output>

pub fn stdout(&self) -> UiStdout<'_>

Locked stdout stream.

pub fn stdout_formatter(&self) -> Box<dyn Formatter + '_>

Creates a formatter for the locked stdout stream.

Labels added to the returned formatter should be removed by caller. Otherwise the last color would persist.

pub fn stderr(&self) -> UiStderr<'_>

Locked stderr stream.

pub fn stderr_formatter(&self) -> Box<dyn Formatter + '_>

Creates a formatter for the locked stderr stream.

pub fn stderr_for_child(&self) -> Result<Stdio>

Stderr stream to be attached to a child process.

pub fn use_progress_indicator(&self) -> bool

Whether continuous feedback should be displayed for long-running operations

pub fn progress_output(&self) -> Option<ProgressOutput<Stderr>>

pub fn status(&self) -> Box<dyn Write + '_>

Writer to print an update that’s not part of the command’s main output.

pub fn status_formatter(&self) -> Option<Box<dyn Formatter + '_>>

A formatter to print an update that’s not part of the command’s main output. Returns None if --quiet was requested.

pub fn hint_default( &self, ) -> HeadingLabeledWriter<Box<dyn Formatter + '_>, &'static str, &'static str>

Writer to print hint with the default “Hint: “ heading.

pub fn hint_no_heading( &self, ) -> LabeledWriter<Box<dyn Formatter + '_>, &'static str>

Writer to print hint without the “Hint: “ heading.

pub fn hint_with_heading<H: Display>( &self, heading: H, ) -> HeadingLabeledWriter<Box<dyn Formatter + '_>, &'static str, H>

Writer to print hint with the given heading.

pub fn warning_default( &self, ) -> HeadingLabeledWriter<Box<dyn Formatter + '_>, &'static str, &'static str>

Writer to print warning with the default “Warning: “ heading.

pub fn warning_no_heading( &self, ) -> LabeledWriter<Box<dyn Formatter + '_>, &'static str>

Writer to print warning without the “Warning: “ heading.

pub fn warning_with_heading<H: Display>( &self, heading: H, ) -> HeadingLabeledWriter<Box<dyn Formatter + '_>, &'static str, H>

Writer to print warning with the given heading.

pub fn error_no_heading( &self, ) -> LabeledWriter<Box<dyn Formatter + '_>, &'static str>

Writer to print error without the “Error: “ heading.

pub fn error_with_heading<H: Display>( &self, heading: H, ) -> HeadingLabeledWriter<Box<dyn Formatter + '_>, &'static str, H>

Writer to print error with the given heading.

pub fn finalize_pager(&mut self)

Waits for the pager exits.

pub fn can_prompt() -> bool

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

pub fn prompt_choice( &self, prompt: &str, choices: &[impl AsRef<str>], default_index: Option<usize>, ) -> Result<usize>

Repeat the given prompt until the input is one of the specified choices. Returns the index of the choice.

pub fn prompt_yes_no(&self, prompt: &str, default: Option<bool>) -> Result<bool>

Prompts for a yes-or-no response, with yes = true and no = false.

pub fn prompt_choice_with<T, E: Debug + Display>( &self, prompt: &str, default: Option<&str>, parse: impl FnMut(&str) -> Result<T, E>, ) -> Result<T>

Repeats the given prompt until parse(input) returns a value.

If the default text is given, an empty input will be mapped to it. It will also be used in non-interactive session. The default text must be parsable. If no default is given, this function will fail in non-interactive session.

pub fn prompt_password(&self, prompt: &str) -> Result<String>

pub fn term_width(&self) -> usize