Struct PreviewState 

pub struct PreviewState {
    pub cached_path: Option<PathBuf>,
    pub content: PreviewContent,
    pub scroll: usize,
    /* private fields */
}

Owns the cached preview content, the path it was generated for, and the current scroll offset.

Fields

cached_path: Option<PathBuf>

Path for which the current content was loaded, or None.

content: PreviewContent

The loaded content.

scroll: usize

Vertical scroll offset (in lines / hex rows / pixel-rows, depending on content kind).

Implementations

impl PreviewState

pub fn new() -> Self

Create a blank preview state.

Falls back to halfblocks because from_query_stdio must be called before the terminal enters the alternate screen. Use PreviewState::with_picker when you can create the picker early.

pub fn with_picker(picker: Picker) -> Self

Create a preview state with a pre-initialised image-protocol picker.

Call ratatui_image::picker::Picker::from_query_stdio (or similar) before entering the alternate screen and pass the result here.

pub fn protocol_type(&self) -> ProtocolType

Return the detected image protocol type (for diagnostics / UI display).

pub fn update(&mut self, path: Option<&Path>, area_width: u16, area_height: u16)

Reload the preview if the path changed or the available area was resized. When neither changed, this is a no-op.

pub fn scroll_up(&mut self, n: usize)

Scroll the preview up by n rows (clamped at zero).

pub fn scroll_down(&mut self, n: usize)

Scroll the preview down by n rows.

pub fn invalidate(&mut self)

Mark the cache as stale so that the next update call reloads even if the path has not changed.

Trait Implementations

impl Default for PreviewState

fn default() -> Self

Returns the “default value” for a type.