Struct viuer::Config

pub struct Config {
    pub transparent: bool,
    pub absolute_offset: bool,
    pub x: u16,
    pub y: i16,
    pub restore_cursor: bool,
    pub width: Option<u32>,
    pub height: Option<u32>,
    pub truecolor: bool,
    pub use_kitty: bool,
    pub use_iterm: bool,
}

Configuration struct to customize printing behaviour.

Fields

transparent: bool

Enable true transparency instead of checkerboard background. Available only for the block printer. Defaults to false.

absolute_offset: bool

Make the x and y offset be relative to the top left terminal corner. If false, the y offset is relative to the cursor’s position. Defaults to true.

x: u16

X offset. Defaults to 0.

y: i16

Y offset. Can be negative only when absolute_offset is false. Defaults to 0.

restore_cursor: bool

Take a note of cursor position before printing and restore it when finished. Defaults to false.

width: Option<u32>

Optional image width. Defaults to None.

height: Option<u32>

Optional image height. Defaults to None.

truecolor: bool

Use truecolor if the terminal supports it. Defaults to true.

use_kitty: bool

Use Kitty protocol if the terminal supports it. Defaults to true.

use_iterm: bool

Use iTerm protocol if the terminal supports it. Defaults to true.

Trait Implementations

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.