Struct ConsoleOptions 

pub struct ConsoleOptions {

    pub size: ConsoleDimensions,
    pub legacy_windows: bool,
    pub min_width: usize,
    pub max_width: usize,
    pub is_terminal: bool,
    pub encoding: Cow<'static, str>,
    pub max_height: usize,
    pub justify: Option<JustifyMethod>,
    pub overflow: Option<OverflowMethod>,
    pub no_wrap: Option<bool>,
    pub highlight: Option<bool>,
    pub markup: Option<bool>,
    pub height: Option<usize>,
}

Options that control how renderables produce segments.

Fields

size: ConsoleDimensions

Terminal dimensions used for layout.

legacy_windows: bool

Whether to use legacy Windows console rendering.

min_width: usize

Minimum width in columns for renderable output.

max_width: usize

Maximum width in columns for renderable output.

is_terminal: bool

Whether the output target is an interactive terminal.

encoding: Cow<'static, str>

Character encoding (always "utf-8" in Rust; Cow avoids allocation per options() call while still letting tests set non-utf encodings for ascii_only() checks — finding #6).

max_height: usize

Maximum height in rows for renderable output.

justify: Option<JustifyMethod>

Text justification override, if any.

overflow: Option<OverflowMethod>

Text overflow strategy override, if any.

no_wrap: Option<bool>

Whether to disable text wrapping.

Tri-state (rich parity):

• None = inherit / wrap by default
• Some(false) = force-wrap (explicit wrap)
• Some(true) = no-wrap (suppress wrapping)

Only Some(true) suppresses wrapping; None and Some(false) both wrap.

highlight: Option<bool>

Whether to enable syntax highlighting, if set.

markup: Option<bool>

Whether to enable markup parsing, if set.

height: Option<usize>

Explicit height constraint for renderables, if set.

Implementations

impl ConsoleOptions

pub fn ascii_only(&self) -> bool

Returns true if the encoding is NOT utf-based (i.e. ASCII-only output).

pub fn copy(&self) -> Self

Clone this options set.

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

Return a new ConsoleOptions with the width replaced.

min_width is clamped so it never exceeds the new width (finding #3).

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

Return a new ConsoleOptions with the height replaced.

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

Return a new ConsoleOptions with both width and height replaced.

pub fn reset_height(&self) -> Self

Return a new ConsoleOptions with height reset to None.

pub fn with_updates(&self, updates: &ConsoleOptionsUpdates) -> Self

Apply a set of optional field updates, returning a new ConsoleOptions.

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.