Struct Tree 

pub struct Tree { /* private fields */ }

A foldable, editable JSON/YAML value tree with a cursor and undo history.

Implementations

impl Tree

pub fn from_text(text: &str, format: Format) -> Result<Self, String>

Parse text as JSON or YAML into a value tree. YAML’s parser also accepts JSON.

Errors

Returns the parser’s own message (line/column included) when text does not parse, instead of discarding it (Run H, T543: this used to return a bare Option, so the caller could only show a static “not valid JSON or YAML” with no indication of what was actually wrong or where).

pub fn format(&self) -> Format

The chosen format.

pub fn row_count(&self) -> usize

Number of visible rows.

pub fn sel(&self) -> usize

The selected row index.

pub fn scroll(&self) -> usize

The first visible row (scroll offset).

pub fn is_dirty(&self) -> bool

Whether there are unsaved edits.

pub fn is_editing(&self) -> bool

Whether a scalar is currently being edited.

pub fn edit_buffer(&self) -> &str

The in-progress edit text (valid while Tree::is_editing).

pub fn depth(&self, i: usize) -> usize

Indentation depth of visible row i.

pub fn label(&self, i: usize) -> &str

The label (key or index) of visible row i.

pub fn value(&self, i: usize) -> &str

The value/summary text of visible row i.

pub fn is_container(&self, i: usize) -> bool

Whether visible row i is a container (object/array).

pub fn is_collapsed(&self, i: usize) -> bool

Whether visible row i is a collapsed container.

pub fn to_text(&self) -> String

Serialize the tree back to text in its format.

pub fn mark_saved(&mut self)

Mark the tree as saved (called by the host after a successful write).

pub fn ensure_visible(&mut self, height: usize)

Adjust the scroll so the selected row stays within a height-row window.

pub fn handle_key(&mut self, key: KeyEvent, page: usize) -> Outcome

Interpret a key event and report what the host should do next.