Struct ConsoleOptions 

pub struct ConsoleOptions {
    pub min_width: usize,
    pub max_width: usize,
    pub height: Option<usize>,
    pub justify: Justify,
    pub overflow: Option<Overflow>,
    pub no_wrap: Option<bool>,
}

The options passed to a Renderable describing the space it must fit into.

Port of the core of rich.console.ConsoleOptions. Only the fields needed by the currently-ported renderables are present; more are added as widgets land.

Fields

min_width: usize

max_width: usize

height: Option<usize>

justify: Justify

overflow: Option<Overflow>

Overflow method to impose on renderables, or None to let each pick its own. Mirrors ConsoleOptions.overflow.

no_wrap: Option<bool>

Disable wrapping, or None to let each renderable pick. Mirrors ConsoleOptions.no_wrap.

Implementations

impl ConsoleOptions

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

Return a copy with max_width (and a clamped min_width) updated. Port of ConsoleOptions.update_width.

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

Return a copy with both width and height pinned. Port of ConsoleOptions.update_dimensions.

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.