Struct RichOutput 

pub struct RichOutput { /* private fields */ }

The main facade for rich console output.

Provides methods for printing styled text, tables, panels, and other visual elements. Automatically adapts output based on the detected environment.

Implementations

impl RichOutput

pub fn new(mode: OutputMode) -> Self

Create a new RichOutput with the specified mode and default theme.

pub fn with_mode(mode: OutputMode) -> Self

Create a new RichOutput with the specified mode.

pub fn auto() -> Self

Create a new RichOutput with auto-detected mode.

pub fn rich() -> Self

Create a new RichOutput with rich mode (for humans).

pub fn plain() -> Self

Create a new RichOutput with plain mode (for agents).

pub fn builder() -> RichOutputBuilder

Create a builder for custom configuration.

pub const fn mode(&self) -> OutputMode

Get the current output mode.

pub fn set_mode(&mut self, mode: OutputMode)

Set the output mode.

pub const fn is_agent_mode(&self) -> bool

Check if running in agent-friendly mode (plain text output).

Returns true if the output mode is Plain, which is the mode used when an AI agent environment is detected or explicitly requested.

Example

use fastapi_output::prelude::*;

let output = RichOutput::plain();
assert!(output.is_agent_mode());

let output = RichOutput::rich();
assert!(!output.is_agent_mode());

pub const fn mode_name(&self) -> &'static str

Get the mode name as a string for logging/debugging.

Returns one of: "rich", "plain", or "minimal".

Example

use fastapi_output::prelude::*;

let output = RichOutput::plain();
assert_eq!(output.mode_name(), "plain");

pub const fn theme(&self) -> &FastApiTheme

Get the current theme.

pub fn set_theme(&mut self, theme: FastApiTheme)

Set the theme.

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

Print a success message.

In rich mode: Green checkmark with styled text. In plain mode: [OK] message

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

Print an error message.

In rich mode: Red X with styled text. In plain mode: [ERROR] message

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

Print a warning message.

In rich mode: Yellow warning symbol with styled text. In plain mode: [WARN] message

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

Print an info message.

In rich mode: Blue info symbol with styled text. In plain mode: [INFO] message

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

Print a debug message (only in non-minimal modes).

In rich mode: Gray text. In plain mode: [DEBUG] message In minimal mode: Nothing printed.

pub fn status(&self, kind: StatusKind, message: &str)

Print a status message with the given kind.

pub fn rule(&self, title: Option<&str>)

Print a horizontal rule/divider.

pub fn panel(&self, content: &str, title: Option<&str>)

Print content in a panel/box.

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

Print raw text.

pub fn with_test_output<F: FnOnce()>(test: &TestOutput, f: F)

Run a closure with test output capture enabled.

pub fn global() -> RwLockReadGuard<'static, RichOutput>

Get the global RichOutput instance.

Panics

pub fn global_mut() -> RwLockWriteGuard<'static, RichOutput>

Get mutable access to the global RichOutput instance.

Trait Implementations

impl Clone for RichOutput

fn clone(&self) -> RichOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RichOutput

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

Formats the value using the given formatter.

impl Default for RichOutput

fn default() -> Self

Returns the “default value” for a type.