Struct State 

pub struct State { /* private fields */ }

Available on crate feature json-viewer only.

The document, what is expanded and highlighted, and the search.

Implementations

impl State

pub fn new(value: Value) -> Self

A viewer of value with everything collapsed. An object or array shows its members as the top rows; anything else shows as one row.

pub fn parse(json: &str) -> Self

Parses JSON text. Text that is not valid JSON gives an empty viewer that shows the error in place of rows.

pub fn with_depth(self, depth: usize) -> Self

Starts with every object and array fewer than depth levels deep expanded.

pub fn with_only_matches(self, only_matches: bool) -> Self

Starts with only the matches shown while searching.

pub fn with_search_id(self, id: impl Into<Id>) -> Self

The search box’s widget id. Defaults to SEARCH; give each viewer its own when a window has several.

pub fn search_id(&self) -> &Id

The search box’s widget id, which focus_search focuses.

pub fn value(&self) -> &Value

The whole document.

pub fn error(&self) -> Option<&ParseError>

Why the text given to parse is not valid JSON.

pub fn len(&self) -> usize

How many nodes the document holds, the document itself included.

pub fn is_empty(&self) -> bool

pub fn roots(&self) -> &[NodeId]

The top rows.

pub fn kind(&self, id: NodeId) -> Option<Kind>

pub fn segment(&self, id: NodeId) -> Option<&Segment>

The key or index the node has in its parent, None for the document.

pub fn parent(&self, id: NodeId) -> Option<NodeId>

The node’s parent row, None for a top row.

pub fn children(&self, id: NodeId) -> &[NodeId]

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

How far the row is indented: 0 for a top row.

pub fn is_expanded(&self, id: NodeId) -> bool

pub fn highlighted(&self) -> Option<NodeId>

The node the keyboard acts on.

pub fn is_focused(&self) -> bool

pub fn query(&self) -> &str

The search text.

pub fn matches(&self) -> &[NodeId]

The nodes whose key or value contains the search text, in document order.

pub fn is_match(&self, id: NodeId) -> bool

pub fn current_match(&self) -> Option<NodeId>

The match Event::NextMatch last moved to.

pub fn is_filtering(&self) -> bool

Whether only matches are shown: only_matches is on and there is a search.

pub fn only_matches(&self) -> bool

Whether a search shows only its matches, searching or not.

pub fn visible(&self) -> Vec<NodeId>

The rows on screen when scrolled through, in document order.

pub fn path(&self, id: NodeId) -> String

The node’s path from the document, such as $.users[2].name or $["first name"].

pub fn value_at(&self, id: NodeId) -> Option<&Value>

The node’s value.

pub fn pretty(&self, id: NodeId) -> Option<String>

The node’s value as pretty-printed JSON.

pub fn update(&mut self, event: Event) -> Option<Output>

Applies an event and returns what the app may need to act on.

pub fn key_event(&self, keymap: &Keymap<Action>, key: &Event) -> Option<Event>

Turns a key press into an event through keymap. A symbol typed with Shift, such as *, also matches its chord without Shift.

Trait Implementations

impl Clone for State

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 State

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

Formats the value using the given formatter.

impl Default for State

fn default() -> Self

Returns the “default value” for a type.