Struct CstRootNode

pub struct CstRootNode(/* private fields */);

Root node in the file.

The root node contains one value, whitespace, and comments.

Implementations

impl CstRootNode

pub fn parent(&self) -> Option<CstContainerNode>

Parent of the node.

Returns None if this node has become disconnected from the tree by being removed.

pub fn ancestors(&self) -> impl Iterator<Item = CstContainerNode>

An iterator of ancestors of this node.

pub fn child_index(&self) -> usize

Current child index of the node within the children of the parent node.

pub fn previous_sibling(&self) -> Option<CstNode>

Node that comes before this one that shares the same parent.

pub fn previous_siblings(&self) -> impl Iterator<Item = CstNode>

Siblings coming before this node. This does not include cousins.

pub fn next_sibling(&self) -> Option<CstNode>

Node that comes after this one that shares the same parent.

pub fn next_siblings(&self) -> impl Iterator<Item = CstNode>

Siblings coming after this node. This does not include cousins.

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

Returns the indentation text if it can be determined.

pub fn trailing_comma(&self) -> Option<CstToken>

Gets the trailing comma token of the node, if it exists.

pub fn uses_trailing_commas(&self) -> bool

Infers if the node or appropriate ancestor uses trailing commas.

pub fn children(&self) -> Vec<CstNode>

Children of the current node.

pub fn children_exclude_trivia_and_tokens(&self) -> Vec<CstNode>

Children of the current node excluding comments, whitespace, newlines, and tokens.

pub fn child_at_index(&self, index: usize) -> Option<CstNode>

Gets the child at the specified index.

impl CstRootNode

pub fn parse( text: &str, parse_options: &ParseOptions, ) -> Result<Self, ParseError>

Parses the text into a CST.

WARNING: You MUST not drop the root node for the duration of using the CST or a panic could occur in certain scenarios. This is because the CST uses weak references for ancestors and if the root node is dropped then the weak reference will be lost and the CST will panic to prevent bugs when a descendant node attempts to access an ancestor that was dropped.

use jsonc_parser::cst::CstRootNode;
use jsonc_parser::ParseOptions;
use jsonc_parser::json;

let json_text = r#"{
  // comment
  "data": 123
}"#;

let root = CstRootNode::parse(json_text, &ParseOptions::default()).unwrap();
let root_obj = root.object_value_or_set();

root_obj.get("data").unwrap().set_value(json!({
  "nested": true
}));
root_obj.append("new_key", json!([456, 789, false]));

assert_eq!(root.to_string(), r#"{
  // comment
  "data": {
    "nested": true
  },
  "new_key": [456, 789, false]
}"#);

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

Computes the single indentation text of the file.

pub fn newline_kind(&self) -> CstNewlineKind

Newline kind used within the JSON text.

pub fn value(&self) -> Option<CstNode>

Gets the root value found in the file.

pub fn set_value(&self, root_value: CstInputValue)

Sets potentially replacing the root value found in the JSON document.

pub fn object_value(&self) -> Option<CstObject>

Gets the root value if its an object.

pub fn object_value_or_create(&self) -> Option<CstObject>

Gets or creates the root value as an object, returns Some if successful or None if the root value already exists and is not an object.

Note: Use .object_value_or_set() to overwrite the root value when it’s not an object.

pub fn object_value_or_set(&self) -> CstObject

Gets the root value if it’s an object or sets the root value as an object.

Note: Use .object_value_or_create() to not overwrite the root value when it’s not an object.

pub fn array_value(&self) -> Option<CstArray>

Gets the value if its an array.

pub fn array_value_or_create(&self) -> Option<CstArray>

Gets or creates the root value as an object, returns Some if successful or None if the root value already exists and is not an object.

Note: Use .array_value_or_set() to overwrite the root value when it’s not an array.

pub fn array_value_or_set(&self) -> CstArray

Gets the root value if it’s an object or sets the root value as an object.

Note: Use .array_value_or_create() to not overwrite the root value when it’s not an object.

pub fn set_trailing_commas(&self, mode: TrailingCommaMode)

Ensures this object’s values use trailing commas.

Note: This does not cause future values to use trailing commas. That will always be determined based on whether the file uses trailing commas or not, so it’s probably best to do this last.

pub fn clear_children(&self)

Clears all the children from the root node making it empty.

Trait Implementations

impl Clone for CstRootNode

fn clone(&self) -> CstRootNode

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CstRootNode

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

Formats the value using the given formatter.

impl Display for CstRootNode

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

Formats the value using the given formatter.

impl From<CstRootNode> for CstContainerNode

fn from(value: CstRootNode) -> Self

Converts to this type from the input type.

impl From<CstRootNode> for CstNode

fn from(value: CstRootNode) -> Self

Converts to this type from the input type.