Enum OutputMode 

pub enum OutputMode {
    Auto,
    Term,
    Text,
    TermDebug,
    Json,
    Yaml,
    Xml,
    Csv,
}

Controls how output is rendered.

This determines whether ANSI escape codes are included in the output, or whether to output structured data formats like JSON.

Variants

• Auto - Detect terminal capabilities automatically (default behavior)
• Term - Always include ANSI escape codes (for terminal output)
• Text - Never include ANSI escape codes (plain text)
• TermDebug - Render style names as bracket tags for debugging
• Json - Serialize data as JSON (skips template rendering)

Example

use standout::{render_with_output, Theme, OutputMode};
use console::Style;
use serde::Serialize;

#[derive(Serialize)]
struct Data { message: String }

let theme = Theme::new().add("ok", Style::new().green());
let data = Data { message: "Hello".into() };

// Auto-detect (default)
let auto = render_with_output(
    r#"[ok]{{ message }}[/ok]"#,
    &data,
    &theme,
    OutputMode::Auto,
).unwrap();

// Force plain text
let plain = render_with_output(
    r#"[ok]{{ message }}[/ok]"#,
    &data,
    &theme,
    OutputMode::Text,
).unwrap();
assert_eq!(plain, "Hello");

// Debug mode - renders bracket tags
let debug = render_with_output(
    r#"[ok]{{ message }}[/ok]"#,
    &data,
    &theme,
    OutputMode::TermDebug,
).unwrap();
assert_eq!(debug, "[ok]Hello[/ok]");

Variants

Auto

Auto-detect terminal capabilities

Term

Always use ANSI escape codes (terminal output)

Text

Never use ANSI escape codes (plain text)

TermDebug

Debug mode: render style names as bracket tags [name]text[/name]

Json

Structured output: serialize data as JSON (skips template rendering)

Yaml

Structured output: serialize data as YAML (skips template rendering)

Xml

Structured output: serialize data as XML (skips template rendering)

Csv

Structured output: serialize flattened data as CSV (skips template rendering)

Implementations

impl OutputMode

pub fn should_use_color(&self) -> bool

Resolves the output mode to a concrete decision about whether to use color.

• Auto checks terminal capabilities
• Term always returns true
• Text always returns false
• TermDebug returns false (handled specially by apply methods)
• Json returns false (structured output, no ANSI codes)

pub fn is_debug(&self) -> bool

Returns true if this is debug mode (bracket tags instead of ANSI).

pub fn is_structured(&self) -> bool

Returns true if this is a structured output mode (JSON, etc.).

Structured modes serialize data directly instead of rendering templates.

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 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 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 Copy for OutputMode

impl Eq for OutputMode

impl StructuralPartialEq for OutputMode