Skip to main content

OutputContext

Enum OutputContext 

Source
pub enum OutputContext {
    Hook,
    Machine,
    Interactive,
    Colored,
    Plain,
}
Expand description

Output context determines what level of rich formatting to use.

RCH operates in multiple contexts with vastly different output requirements:

ContextRich OK?Why
Hook modeNOAgent reads JSON from stdout
InteractiveYESHuman at terminal
Piped outputMAYBEDepends on FORCE_COLOR
Daemon serviceNONo terminal, logs only
Worker executeNOOutput goes to agent

Variants§

§

Hook

Hook mode - JSON protocol only, ZERO decoration. Detected when: JSON on stdin, or called as hook subprocess.

§

Machine

Machine-readable output explicitly requested. Detected when: –json flag, RCH_JSON=1, –format=json.

§

Interactive

Interactive terminal session. Detected when: stderr is TTY, not hook mode.

§

Colored

Colored output but no full rich (no tables/panels). Detected when: FORCE_COLOR set but no TTY.

§

Plain

Plain text only, no ANSI codes. Detected when: NO_COLOR set, or no TTY and no FORCE_COLOR.

Implementations§

Source§

impl OutputContext

Source

pub fn detect() -> Self

Detect the current output context automatically.

Detection order (first match wins):

  1. RCH_JSON=1 -> Machine
  2. Hook invocation detection -> Hook
  3. NO_COLOR set -> Plain
  4. FORCE_COLOR=0 -> Plain
  5. stderr is TTY -> Interactive
  6. FORCE_COLOR set -> Colored
  7. Default -> Plain
Source

pub const fn plain() -> Self

Create a context that explicitly uses plain text (no colors/formatting).

Source

pub const fn interactive() -> Self

Create a context that explicitly uses interactive mode.

Source

pub const fn machine() -> Self

Create a context for hook/machine output.

Source

pub const fn supports_rich(&self) -> bool

Can we use full rich output (tables, panels, etc)?

Source

pub const fn supports_color(&self) -> bool

Can we use ANSI color codes?

Source

pub const fn is_machine(&self) -> bool

Is this machine-readable output mode?

Source

pub const fn is_decorated(&self) -> bool

Should we output ANYTHING decorative?

Source

pub fn supports_unicode(&self) -> bool

Can we use Unicode characters (box drawing, etc)?

Checks locale environment variables for UTF-8 support.

Trait Implementations§

Source§

impl Clone for OutputContext

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for OutputContext

Source§

impl Debug for OutputContext

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for OutputContext

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Display for OutputContext

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for OutputContext

Source§

impl PartialEq for OutputContext

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for OutputContext

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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