Struct ImagePreview 

pub struct ImagePreview {
    pub protocol: Box<dyn StatefulProtocol>,
    pub caption: String,
    pub draws_over_cells: bool,
    pub placed_at: Option<Rect>,
}

A decoded image ready to be drawn into the preview pane.

Held in PreviewContent::Image. The protocol state is mutable because ratatui-image re-encodes the image whenever the pane it is drawn into changes size, caching the result until the next resize.

Fields

protocol: Box<dyn StatefulProtocol>

Encoder state for the active protocol.

caption: String

One-line summary drawn beneath the image (format, dimensions, size and the protocol in use).

draws_over_cells: bool

Whether the terminal draws this image over cells ratatui skips, fixed when the image is built because a preview keeps its protocol.

placed_at: Option<Rect>

The preview pane this image was last drawn into, or None if it has not been drawn or the pane was hidden since.

The cells an image reserves are never repainted by ratatui, yet the picture may not reach all of them: Trail assumes a cell size, and where the real cells are larger the image stops short. Whatever the screen held in that gap therefore stays visible. ui::render clears the screen when this differs from the pane about to be drawn, which is the only moment such leftovers can appear.

Implementations

impl ImagePreview

pub fn new(protocol: Box<dyn StatefulProtocol>, caption: String) -> ImagePreview

Wraps a built encoder as a preview that has not been drawn yet, under the protocol currently in effect.

Trait Implementations

impl Clone for ImagePreview

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImagePreview

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

StatefulProtocol is a trait object with no Debug bound, so the encoder state is summarised rather than printed.