Struct SqlModelConsole 

pub struct SqlModelConsole { /* private fields */ }

Main coordinator for all SQLModel console output.

SqlModelConsole provides a unified API for rendering output that automatically adapts to the detected output mode (Plain, Rich, or Json).

Example

use sqlmodel_console::{SqlModelConsole, OutputMode};

let console = SqlModelConsole::new();
console.print("Hello, world!");
console.status("Processing...");
console.success("Done!");

Implementations

impl SqlModelConsole

pub fn new() -> Self

Create a new console with auto-detected mode and default theme.

This is the recommended way to create a console. It will:

1. Check environment variables for explicit mode
2. Detect AI agent environments
3. Check terminal capabilities
4. Choose appropriate mode

pub fn with_mode(mode: OutputMode) -> Self

Create a console with a specific output mode.

Use this when you need to force a specific mode regardless of environment.

pub fn with_theme(theme: Theme) -> Self

Create a console with a specific theme.

pub fn theme(self, theme: Theme) -> Self

Builder method to set the theme.

pub fn plain_width(self, width: usize) -> Self

Builder method to set the plain mode width.

pub const fn mode(&self) -> OutputMode

Get the current output mode.

pub const fn get_theme(&self) -> &Theme

Get the current theme.

pub const fn get_plain_width(&self) -> usize

Get the plain mode width.

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

Set the output mode.

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

Set the theme.

pub fn is_rich(&self) -> bool

Check if rich output is active.

pub fn is_plain(&self) -> bool

Check if plain output is active.

pub fn is_json(&self) -> bool

Check if JSON output is active.

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

Print a message to stdout.

In rich mode, supports markup syntax: [bold red]text[/] In plain mode, prints without formatting (markup stripped). In JSON mode, regular prints go to stderr to keep stdout clean.

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

Print to stdout without any markup processing.

Use this when you need raw output without markup stripping.

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

Print a message followed by a newline to stderr.

Status messages are always sent to stderr because:

• Agents typically only parse stdout
• Status messages are transient/informational
• Separating streams helps with output redirection

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

Print a success message (green with checkmark).

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

Print an error message (red with X).

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

Print a warning message (yellow with warning sign).

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

Print an info message (cyan with info symbol).

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

Print a horizontal rule/divider.

Optionally includes a title centered in the rule.

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

Output JSON to stdout (compact format for parseability).

Returns an error if serialization fails.

pub fn print_json_pretty<T: Serialize>(&self, value: &T) -> Result<(), Error>

Output pretty-printed JSON to stdout.

In rich mode, could include syntax highlighting (not yet implemented).

pub fn newline(&self)

Print an empty line to stdout.

pub fn newline_stderr(&self)

Print an empty line to stderr.

Trait Implementations

impl Clone for SqlModelConsole

fn clone(&self) -> SqlModelConsole

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SqlModelConsole

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

Formats the value using the given formatter.

impl Default for SqlModelConsole

fn default() -> Self

Returns the “default value” for a type.