Struct Ui 

pub struct Ui<W: Write> {
    pub(crate) out: BufWriter<W>,
    pub(crate) err: Box<dyn Write>,
    pub(crate) color_enabled: bool,
    pub(crate) default_yes: bool,
    pub(crate) spinner_style: Arc<ProgressStyle>,
    pub(crate) progress_style: Arc<ProgressStyle>,
}

Terminal-backed presentation state used by CLI command handlers.

Fields

out: BufWriter<W>

err: Box<dyn Write>

color_enabled: bool

default_yes: bool

spinner_style: Arc<ProgressStyle>

progress_style: Arc<ProgressStyle>

Implementations

impl<W: Write> Ui<W>

pub fn page_title(&mut self, title: &str)

pub fn confirm(&mut self, message: &str, default: bool) -> Result<bool>

pub fn prompt_text( &mut self, message: &str, default: Option<&str>, ) -> Result<String>

pub fn prompt_number(&mut self, message: &str, max: usize) -> Result<usize>

pub fn select_index(&mut self, message: &str, items: &[String]) -> Result<usize>

impl<W: Write> Ui<W>

pub fn write_line(&mut self, message: impl Display)

pub fn info(&mut self, message: impl Display)

pub fn notice(&mut self, message: impl Display)

notice is reserved for neutral status messages; may gain distinct formatting in future (e.g. dimmed). Prefer info for general output.

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

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

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

impl<W: Write> Ui<W>

pub fn progress_bar(&self) -> ProgressHandle

pub fn start_spinner(&self, message: impl Into<String>) -> SpinnerGuard

pub fn spinner<T, F: FnOnce() -> T>( &self, message: impl Into<String>, f: F, ) -> T

impl<W: Write> Ui<W>

fn render_table(&mut self, table: Table)

pub fn display_packages(&mut self, packages: &[InstalledPackage])

pub fn display_catalog_packages(&mut self, packages: &[CatalogPackage])

pub fn display_key_values(&mut self, rows: &[(String, String)])

fn build_table(&self, headers: impl IntoIterator<Item = Cell>) -> Table

fn render_section_label(&mut self, label: &str)

impl Ui<Stdout>

pub fn new(settings: UiSettings) -> Self

Create a UI that writes to stdout and stderr.

impl<W: Write> Ui<W>

pub fn with_writer(writer: W, settings: UiSettings) -> Self

Create a UI with an explicit writer, which is primarily useful in tests.

Trait Implementations

impl Default for Ui<Stdout>

fn default() -> Self

Returns the “default value” for a type.