Skip to main content

OutputConfig

Struct OutputConfig 

Source
pub struct OutputConfig {
    pub format: OutputFormat,
    pub verbose: bool,
    pub debug: bool,
    pub quiet: bool,
    pub color: bool,
}
Expand description

Resolved output configuration for a CLI invocation.

Created once at startup via crate::cli::build_output_config and passed down through command handlers.

Fields§

§format: OutputFormat

Output format (human or JSON)

§verbose: bool

Whether verbose output is enabled (includes --debug)

§debug: bool

Whether debug output is enabled (superset of verbose)

§quiet: bool

Whether quiet mode is active (suppress info/step output)

§color: bool

Whether ANSI color codes are allowed

Implementations§

Source§

impl OutputConfig

Source

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

Print a step completion line in human mode.

Per D-01: each step that completes prints a checkmark prefix + message. In JSON mode, this is a no-op (JSON commands emit a single JSON object at end). In quiet mode, this is also suppressed.

Source

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

Print an indented substep line in human mode.

Per D-04: substeps are indented bullet points under a parent step. Silent in JSON mode and quiet mode.

Source

pub fn print_error(&self, error: &OlError)

Print a formatted OlError to stderr.

In human mode: structured multi-line error with OL code, suggestion, and docs URL. In JSON mode: JSON object on stderr with {"error": {...}}.

Source

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

Print an informational message to stderr.

Silent in quiet mode and JSON mode.

Source

pub fn print_json<T: Serialize>(&self, value: &T)

Serialize a value as pretty JSON to stdout.

Used by commands to emit their JSON output. Silently skips serialization errors rather than panicking (logs a debug message instead).

Source

pub fn is_quiet(&self) -> bool

Returns true if quiet mode is active.

Source

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

Create an indicatif progress spinner writing to stderr.

Per CLI-11: progress spinners write to stderr, not stdout, so they don’t contaminate machine-parseable stdout output.

Returns None if quiet mode or JSON mode is active (no spinners in non-interactive or machine-readable contexts).

Trait Implementations§

Source§

impl Clone for OutputConfig

Source§

fn clone(&self) -> OutputConfig

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 OutputConfig

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,