Struct ConsoleOptions 

pub struct ConsoleOptions {

    pub size: (usize, usize),
    pub min_width: usize,
    pub max_width: usize,
    pub max_height: usize,
    pub height: Option<usize>,
    pub is_terminal: bool,
    pub encoding: String,
    pub legacy_windows: bool,
    pub justify: Option<JustifyMethod>,
    pub overflow: Option<OverflowMethod>,
    pub no_wrap: bool,
    pub highlight: Option<bool>,
    pub markup: Option<bool>,
    pub theme_stack: ThemeStack,
    pub theme_name: String,
    pub markup_enabled: bool,
    pub emoji_enabled: bool,
    pub highlight_enabled: bool,
    pub tab_size: usize,
    pub disable_line_wrap: bool,
    pub color_system: Option<ColorSystem>,
}

Options passed through the rendering pipeline.

This struct carries rendering context that flows through the entire render pipeline, allowing renderables to adapt to the output context.

Console State

In addition to rendering options, this struct carries console configuration that renderables may need to access (theme styles, feature flags, etc.). This allows nested renderables to access console configuration without needing a direct reference to the Console.

Fields

size: (usize, usize)

Terminal dimensions as (width, height).

min_width: usize

Minimum width for rendering.

max_width: usize

Maximum width for rendering.

max_height: usize

Maximum height constraint.

height: Option<usize>

Optional height constraint for specific renderables.

is_terminal: bool

Whether output is to a terminal (vs file/pipe).

encoding: String

Character encoding.

legacy_windows: bool

Whether to use legacy Windows console.

justify: Option<JustifyMethod>

Text justification override.

overflow: Option<OverflowMethod>

Text overflow handling override.

no_wrap: bool

Disable text wrapping.

highlight: Option<bool>

Highlight override for render_str.

markup: Option<bool>

Markup parsing enabled.

theme_stack: ThemeStack

Theme stack for style lookups. Cloned from the console.

theme_name: String

Current theme name (e.g., “default”, “dracula”). Renderables can use this to match their theme to the console.

markup_enabled: bool

Whether markup parsing is enabled by default.

emoji_enabled: bool

Whether emoji replacement is enabled by default.

highlight_enabled: bool

Whether highlighting is enabled by default.

tab_size: usize

Tab size for tab expansion.

disable_line_wrap: bool

Disable terminal automatic line wrap while printing.

This prevents “soft wrap” artifacts when output fills exactly the last column of the terminal (common on Windows Terminal and xterm-like VTs).

When enabled and writing to a real terminal, the Console will emit ESC[?7l before printing and ESC[?7h after.

color_system: Option<ColorSystem>

Detected color system (None = no colors).

Implementations

impl ConsoleOptions

pub fn from_terminal() -> Self

Create options from the current terminal.

pub fn get_style(&self, name: &str) -> Option<Style>

Get a style from the theme stack by name.

pub fn ascii_only(&self) -> bool

Check if renderables should use ASCII only.

pub fn copy(&self) -> Self

Create a copy of the options.

pub fn update( &self, width: Option<usize>, min_width: Option<usize>, max_width: Option<usize>, justify: Option<Option<JustifyMethod>>, overflow: Option<Option<OverflowMethod>>, no_wrap: Option<bool>, highlight: Option<Option<bool>>, markup: Option<Option<bool>>, height: Option<Option<usize>>, ) -> Self

Update values and return a new copy.

Only non-None values in the update parameters will override the existing values.

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

Update just the width, return a copy.

pub fn update_height(&self, height: usize) -> Self

Update the height and return a copy.

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

Update both width and height, return a copy.

pub fn reset_height(&self) -> Self

Reset height to None, return a copy.

Trait Implementations

impl Clone for ConsoleOptions

fn clone(&self) -> ConsoleOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConsoleOptions

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

Formats the value using the given formatter.

impl Default for ConsoleOptions

fn default() -> Self

Returns the “default value” for a type.