Enum ImageProtocol 

pub enum ImageProtocol {
    Kitty,
    Iterm2,
    Sixel,
    Halfblocks,
    None,
}

The mechanism used to draw pixel previews in the terminal.

Variants

Kitty

Kitty graphics protocol — Kitty, Ghostty, Konsole, WezTerm.

Iterm2

iTerm2 inline images — iTerm2, WezTerm, mintty, Tabby, Hyper, VS Code.

Sixel

Sixel graphics — mlterm, foot, xterm built with sixel support.

Halfblocks

Unicode half-blocks. Needs no terminal support, so it is the floor rather than a failure case.

None

Image previews disabled; show metadata only.

Implementations

impl ImageProtocol

pub fn label(self) -> &'static str

The name used for this protocol in config files and in the preview caption.

pub fn parse(value: &str) -> Option<ImageProtocol>

Parses a [preview] image_protocol value.

Returns None for an unrecognised name so the config layer can report it. "auto" is not handled here — it is the absence of an override.

pub fn draws_over_cells(self) -> bool

Whether the terminal, rather than ratatui’s cells, draws the picture.

True of every protocol but half-blocks, which is ordinary coloured text. Such a picture covers cells ratatui is told to leave alone, and only the terminal knows how many of them it really reached — see ImagePreview::placed_at.

Trait Implementations

impl Clone for ImageProtocol

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ImageProtocol

impl Debug for ImageProtocol

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

Formats the value using the given formatter.

impl Eq for ImageProtocol

impl PartialEq for ImageProtocol

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ImageProtocol