Struct DocState 

pub struct DocState {
    pub doc: Option<Documented>,
    pub measured: Option<u64>,
    pub cursor: usize,
    pub scroll: usize,
    pub expanded: HashSet<String>,
    pub view_height: usize,
    pub links_open: bool,
}

The view’s state: the page shown, where the cursor is, which legends are open.

Fields

doc: Option<Documented>

measured: Option<u64>

What has measured the file, if anything has: shown in place of the hint.

cursor: usize

Index into Self::lines of the line the cursor is on.

scroll: usize

First visual row drawn.

expanded: HashSet<String>

Columns whose legends are open.

view_height: usize

Rows the last frame had room for, for paging.

links_open: bool

Whether o opens a link here: set by the app when it opens the page.

Implementations

impl DocState

pub fn open(&mut self, doc: Documented, measured: Option<u64>)

Show doc, from the top, every legend closed.

pub fn close(&mut self)

pub fn is_open(&self) -> bool

pub fn lines(&self) -> Vec<DocLine>

pub fn move_cursor(&mut self, delta: isize)

Move the cursor delta focusable lines, stopping at either end.

pub fn toggle_legend(&mut self) -> bool

Open or close the legend of the column the cursor is on. False when it is not on a column with one.

pub fn link(&self) -> Option<String>

The link on the cursor’s line, as the page has it: what o offers to open. Only a Link line’s; a value or a bookmark is never opened.

pub fn offers_open(&self) -> bool

Whether the footer offers o: on a link, where a browser would show it.

pub fn copy_text(&self) -> Option<String>

What y copies at the cursor.

Trait Implementations

impl Clone for DocState

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 DocState

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

Formats the value using the given formatter.

impl Default for DocState

fn default() -> Self

Returns the “default value” for a type.