egui_json_tree 0.15.0

An interactive JSON tree visualiser for egui, with search and highlight functionality.
Documentation
use std::collections::HashSet;

use egui::Id;

#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash)]
/// Configuration for how a [`JsonTree`](crate::JsonTree) should expand arrays and objects by default.
pub enum DefaultExpand<'a> {
    /// Expand all arrays and objects.
    All,
    /// Collapse all arrays and objects.
    #[default]
    None,
    /// Expand arrays and objects according to how many levels deep they are nested:
    /// - `0` would expand a top-level array/object only,
    /// - `1` would expand a top-level array/object and any array/object that is a direct child,
    /// - `2` ...
    ///
    /// And so on.
    ToLevel(u8),
    /// Expand arrays and objects to display object keys and values,
    /// and array elements, that match the search term. Letter case is ignored. The matches are highlighted.
    /// If the search term is empty, nothing will be expanded by default.
    SearchResults(&'a str),
    /// Similar to `SearchResults`, but expands all arrays and objects if the search term is empty.
    SearchResultsOrAll(&'a str),
}

#[derive(Debug)]
/// Internal representation for the [`DefaultExpand`] setting.
pub(crate) enum InnerDefaultExpand {
    All,
    None,
    ToLevel(u8),
    /// Specifies which arrays/objects should be expanded by default, based on its hashed JSON pointer.
    Paths(HashSet<Id>),
}