Skip to main content

OutputContext

Struct OutputContext 

Source
pub struct OutputContext {
    pub format: OutputFormat,
    pub color_enabled: bool,
    pub is_tty: bool,
    pub term_width: u16,
    pub verbose: bool,
    pub quiet: bool,
}
Expand description

Output context carrying terminal capabilities and user preferences.

§Invariants

  • format matches the user’s --format flag.
  • color_enabled accounts for --color, NO_COLOR env, and terminal detection.
  • is_tty is true only when stdout is an interactive terminal.
  • verbose and quiet are never both true.

Fields§

§format: OutputFormat

Selected output format.

§color_enabled: bool

Whether color output is enabled (resolved from flag + env + terminal).

§is_tty: bool

Whether stdout is an interactive terminal.

§term_width: u16

Terminal width in columns. Falls back to 80.

§verbose: bool

Whether verbose output is requested.

§quiet: bool

Whether quiet mode is requested (errors only).

Implementations§

Source§

impl OutputContext

Source

pub fn from_global_opts(opts: &GlobalOpts) -> Self

Construct an OutputContext from the global CLI options.

COLD PATH — called once per invocation.

Source

pub fn render<T: Serialize + HumanRenderable>(&self, result: &T)

Print a structured result in the selected format.

COLD PATH — called once per command result.

Source

pub fn print_status(&self, symbol: &str, message: &str)

Print a progress message (suppressed in quiet mode and JSON mode).

Source

pub fn print_warning(&self, message: &str)

Print a warning message.

Source

pub fn print_fatal(&self, message: &str)

Print a fatal error message (always shown, even in quiet mode).

Source

pub fn print_debug(&self, message: &str)

Print a debug message (only in verbose mode).

Source

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

Create an indicatif progress bar. Returns None if inappropriate.

Source

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

Create a spinner for unbounded operations. Returns None if inappropriate.

Trait Implementations§

Source§

impl Clone for OutputContext

Source§

fn clone(&self) -> OutputContext

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OutputContext

Source§

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

Formats the value using the given formatter. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<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