Struct ConsoleOptions 

pub struct ConsoleOptions {

    pub size: ConsoleDimensions,
    pub is_terminal: bool,
    pub encoding: String,
    pub min_width: usize,
    pub max_width: usize,
    pub max_height: usize,
    pub justify: Option<AlignMethod>,
    pub overflow: Option<OverflowMethod>,
    pub no_wrap: bool,
    pub ascii_only: bool,
    pub markup: bool,
    pub highlight: bool,
    pub height: Option<usize>,
    pub legacy_windows: bool,
}

Options passed to renderables during rendering.

Fields

size: ConsoleDimensions

Terminal size.

is_terminal: bool

True if output is a terminal.

encoding: String

The encoding (almost always UTF-8).

min_width: usize

Minimum render width.

max_width: usize

Maximum render width.

max_height: usize

Maximum height.

justify: Option<AlignMethod>

Override for text justification.

overflow: Option<OverflowMethod>

Override for overflow handling.

no_wrap: bool

Disable text wrapping.

ascii_only: bool

If true, use ASCII-only box characters.

markup: bool

If true, enable markup interpretation.

highlight: bool

If true, enable syntax highlighting of strings.

height: Option<usize>

Optional fixed height for the renderable.

legacy_windows: bool

For legacy Windows console.

Implementations

impl ConsoleOptions

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

Update the max width.

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

Update the height.

pub fn shrink_width(&self, amount: usize) -> Self

Shrink the max width by an amount (for padding).

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.