Struct Console 

pub struct Console { /* private fields */ }

The main console type for rich terminal output.

Implementations

impl Console

pub fn new() -> Self

Create a new Console writing to stdout.

pub fn stderr() -> Self

Create a new Console writing to stderr.

pub fn capture() -> Self

Create a new Console that captures output to memory.

Useful for testing output verification.

pub fn get_captured_output(&self) -> String

Get the captured output as a string (if using capture mode).

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

Set a fixed terminal width.

pub fn force_color(self, force: bool) -> Self

Force color output even when not detected.

pub fn color_system(self, system: ColorSystem) -> Self

Set the color system explicitly.

pub fn markup(self, enabled: bool) -> Self

Enable or disable markup parsing.

pub fn emoji(self, enabled: bool) -> Self

Enable or disable emoji shortcode translation.

pub fn soft_wrap(self, enabled: bool) -> Self

Enable or disable soft word wrapping.

pub fn record(self, enabled: bool) -> Self

Enable or disable recording of output.

pub fn start_recording(&self)

Start recording output.

pub fn stop_recording(&self)

Stop recording output.

pub fn get_width(&self) -> usize

Get the current terminal width.

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

Print a string with markup support.

pub fn print_renderable(&self, renderable: &dyn Renderable)

Print any renderable object.

pub fn println(&self, content: &str)

Print a line (with newline at the end).

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

Print a string without markup parsing.

Use this when printing content that may contain brackets [...] that should NOT be interpreted as markup (e.g., debug output).

pub fn println_raw(&self, content: &str)

Print a line without markup parsing (with newline at the end).

Use this when printing content that may contain brackets [...] that should NOT be interpreted as markup (e.g., debug output).

pub fn newline(&self)

Print an empty line.

pub fn clear(&self)

Clear the screen.

pub fn show_cursor(&self, show: bool)

Show or hide the cursor.

pub fn move_cursor_up(&self, n: u16)

Move the cursor up by n lines.

pub fn move_cursor_down(&self, n: u16)

Move the cursor down by n lines.

pub fn clear_line(&self)

Clear the current line.

pub fn rule(&self, title: &str)

Show a rule (horizontal line).

pub fn print_debug<T: Debug>(&self, obj: &T)

Pretty print a debug-printable object.

Uses syntax highlighting if the syntax feature is enabled.

pub fn export_text(&self, renderable: &dyn Renderable) -> String

Export a renderable as plain text.

Returns the plain text representation without any ANSI codes.

pub fn export_html(&self, renderable: &dyn Renderable) -> String

Export a renderable as HTML with inline styles.

Returns an HTML string with styled <span> elements.

pub fn save_html(&self, path: &str) -> Result<()>

Save the recorded output as HTML.

pub fn export_svg(&self, renderable: &dyn Renderable) -> String

Export a renderable as SVG.

Returns an SVG string with text elements.

pub fn save_svg(&self, path: &str) -> Result<()>

Save the recorded output as SVG.

Trait Implementations

impl ConsoleLog for Console

fn log(&self, message: &str)

Log a message with timestamp and location.

fn debug(&self, message: &str)

Log a debug message.

fn warn(&self, message: &str)

Log a warning message.

fn error(&self, message: &str)

Log an error message.

impl Debug for Console

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

Formats the value using the given formatter.

impl Default for Console

fn default() -> Self

Returns the “default value” for a type.