Enum CstNode

pub enum CstNode {
    Container(CstContainerNode),
    Leaf(CstLeafNode),
}

All the different kinds of nodes that can appear in the CST.

Variants

Container(CstContainerNode)

Leaf(CstLeafNode)

Implementations

impl CstNode

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 root_node(&self) -> Option<CstRootNode>

Gets the root node.

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

pub fn is_trivia(&self) -> bool

Gets if this node is comments, whitespace, newlines, or a non-literal token (ex. brace, colon).

pub fn leading_comments_same_line(&self) -> impl Iterator<Item = CstComment>

Comments that become before this one on the same line.

pub fn trailing_comments_same_line(&self) -> impl Iterator<Item = CstComment>

Comments that come after this one on the same line.

Only returns owned trailing comments on the same line and not if owned by the next node.

pub fn is_newline(&self) -> bool

If this node is a newline.

pub fn is_comma(&self) -> bool

If this node is a comma.

pub fn is_comment(&self) -> bool

If this node is a comment.

pub fn is_token(&self) -> bool

If this node is a token.

pub fn is_whitespace(&self) -> bool

If this node is whitespace.

pub fn token_char(&self) -> Option<char>

Token char of the node if it’s a token.

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

Children of this 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>

Child at the specified index.

pub fn element_index(&self) -> Option<usize>

Gets the array element index of this node if its parent is an array.

Returns None when the parent is not an array.

pub fn as_root_node(&self) -> Option<CstRootNode>

Node if it’s the root node.

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

Node if it’s an object.

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

Node if it’s an array.

pub fn as_object_prop(&self) -> Option<CstObjectProp>

Node if it’s an object property.

pub fn as_boolean_lit(&self) -> Option<CstBooleanLit>

Node if it’s a boolean literal.

pub fn as_null_keyword(&self) -> Option<CstNullKeyword>

Node if it’s a null keyword.

pub fn as_number_lit(&self) -> Option<CstNumberLit>

Node if it’s a number literal.

pub fn as_string_lit(&self) -> Option<CstStringLit>

Node if it’s a string literal.

pub fn as_word_lit(&self) -> Option<CstWordLit>

Node if it’s a word literal.

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

Node if it’s a token.

pub fn as_newline(&self) -> Option<CstNewline>

Node if it’s a newline.

pub fn as_whitespace(&self) -> Option<CstWhitespace>

Node if it’s whitespace.

pub fn as_comment(&self) -> Option<CstComment>

Node if it’s a comment.

pub fn remove(self)

Removes the node from the JSON.

Note: Removing certain nodes may cause syntax errors.

Trait Implementations

impl Clone for CstNode

fn clone(&self) -> CstNode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CstNode

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

Formats the value using the given formatter.

impl Display for CstNode

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

Formats the value using the given formatter.

impl From<CstArray> for CstNode

fn from(value: CstArray) -> Self

Converts to this type from the input type.

impl From<CstBooleanLit> for CstNode

fn from(value: CstBooleanLit) -> Self

Converts to this type from the input type.

impl From<CstComment> for CstNode

fn from(value: CstComment) -> Self

Converts to this type from the input type.

impl From<CstContainerNode> for CstNode

fn from(value: CstContainerNode) -> Self

Converts to this type from the input type.

impl From<CstLeafNode> for CstNode

fn from(value: CstLeafNode) -> Self

Converts to this type from the input type.

impl From<CstNewline> for CstNode

fn from(value: CstNewline) -> Self

Converts to this type from the input type.

impl From<CstNullKeyword> for CstNode

fn from(value: CstNullKeyword) -> Self

Converts to this type from the input type.

impl From<CstNumberLit> for CstNode

fn from(value: CstNumberLit) -> Self

Converts to this type from the input type.

impl From<CstObject> for CstNode

fn from(value: CstObject) -> Self

Converts to this type from the input type.

impl From<CstObjectProp> for CstNode

fn from(value: CstObjectProp) -> 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.

impl From<CstStringLit> for CstNode

fn from(value: CstStringLit) -> Self

Converts to this type from the input type.

impl From<CstToken> for CstNode

fn from(value: CstToken) -> Self

Converts to this type from the input type.

impl From<CstWhitespace> for CstNode

fn from(value: CstWhitespace) -> Self

Converts to this type from the input type.

impl From<CstWordLit> for CstNode

fn from(value: CstWordLit) -> Self

Converts to this type from the input type.

impl From<ObjectPropName> for CstNode

fn from(value: ObjectPropName) -> Self

Converts to this type from the input type.