Enum OutputMode 

pub enum OutputMode {
    Rich,
    Plain,
    Minimal,
}

Output rendering mode.

Variants

Rich

Full rich_rust styling: colors, boxes, tables, unicode.

Plain

Plain text output with no ANSI codes or special characters.

Minimal

Colors only, no box characters or complex formatting.

Implementations

impl OutputMode

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

Get the mode name as a static string.

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

pub const fn is_agent_friendly(&self) -> bool

Check if this mode is agent-friendly (produces output suitable for parsing).

Returns true for Plain mode, which uses no ANSI codes and consistent text prefixes like [OK], [ERROR], etc.

Example

use fastapi_output::OutputMode;

assert!(OutputMode::Plain.is_agent_friendly());
assert!(!OutputMode::Rich.is_agent_friendly());
assert!(!OutputMode::Minimal.is_agent_friendly());

pub fn auto() -> Self

Select the appropriate mode based on environment detection.

pub const fn uses_colors(&self) -> bool

Check if this mode uses ANSI color codes.

pub const fn uses_boxes(&self) -> bool

Check if this mode uses box-drawing characters.

pub const fn supports_tables(&self) -> bool

Check if this mode supports tables.

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

Get the status indicator for success in this mode.

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

Get the status indicator for errors in this mode.

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

Get the status indicator for warnings in this mode.

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

Get the status indicator for info in this mode.

pub const fn uses_ansi(&self) -> bool

Check if this mode uses ANSI escape codes.

pub const fn is_minimal(&self) -> bool

Check if this mode is minimal.

Trait Implementations

impl Clone for OutputMode

fn clone(&self) -> OutputMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OutputMode

impl Debug for OutputMode

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

Formats the value using the given formatter.

impl Default for OutputMode

fn default() -> OutputMode

Returns the “default value” for a type.

impl Display for OutputMode

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

Formats the value using the given formatter.

impl Eq for OutputMode

impl FromStr for OutputMode

type Err = OutputModeParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for OutputMode

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OutputMode