Skip to main content

Printer

Struct Printer 

Source
pub struct Printer { /* private fields */ }

Implementations§

Source§

impl Printer

Source

pub fn new(verbosity: Verbosity) -> Self

Source

pub fn with_theme( verbosity: Verbosity, theme_config: Option<&ThemeConfig>, ) -> Self

Source

pub fn disable_colors()

Disable color output globally. Wraps the console crate’s color toggle so that no other module needs to depend on console directly.

Source

pub fn with_format( verbosity: Verbosity, theme_config: Option<&ThemeConfig>, output_format: OutputFormat, ) -> Self

Source

pub fn verbosity(&self) -> Verbosity

Source

pub fn for_test() -> (Self, Arc<Mutex<String>>)

Create a Printer that captures all output to a shared buffer. Use in tests to verify output content regardless of verbosity.

Source

pub fn for_test_with_format( output_format: OutputFormat, ) -> (Self, Arc<Mutex<String>>)

Create a Printer with a specific output format that captures to a buffer.

Source

pub fn header(&self, text: &str)

Source

pub fn subheader(&self, text: &str)

Source

pub fn success(&self, text: &str)

Source

pub fn warning(&self, text: &str)

Source

pub fn error(&self, text: &str)

Source

pub fn info(&self, text: &str)

Source

pub fn key_value(&self, key: &str, value: &str)

Source

pub fn diff(&self, old: &str, new: &str)

Source

pub fn syntax_highlight(&self, code: &str, language: &str)

Source

pub fn progress_bar(&self, total: u64, message: &str) -> ProgressBar

Source

pub fn spinner(&self, message: &str) -> ProgressBar

Source

pub fn multi_progress(&self) -> &MultiProgress

Source

pub fn plan_phase(&self, name: &str, items: &[String])

Source

pub fn table(&self, headers: &[&str], rows: &[Vec<String>])

Source

pub fn prompt_confirm(&self, message: &str) -> Result<bool, InquireError>

Source

pub fn prompt_select<'a>( &self, message: &str, options: &'a [String], ) -> Result<&'a String, InquireError>

Source

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

Source

pub fn newline(&self)

Source

pub fn stdout_line(&self, text: &str)

Write a line to stdout (for machine-readable data output, not UI). Used by commands like config get whose output may be captured by scripts.

Source

pub fn is_structured(&self) -> bool

Whether structured output mode is active (not table or wide).

Source

pub fn is_wide(&self) -> bool

Returns true when -o wide was specified, enabling extra columns.

Source

pub fn write_structured<T: Serialize>(&self, value: &T) -> bool

Write a serializable value as structured output to stdout. Returns true if output was emitted (caller should skip human formatting). Returns false if output format is Table/Wide (caller should do human formatting).

Source

pub fn run_with_output( &self, cmd: &mut Command, label: &str, ) -> Result<CommandOutput>

Run a command with live output display.

TTY mode: shows a spinner with the last N lines of output in a bounded region. On success, collapses to a summary line. On failure, shows full stderr.

Non-TTY / quiet mode: streams output lines as they arrive. Captures stdout/stderr for the return value.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more