Struct CstArray 

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

Represents an array that may contain elements (ex. [], [1, 2, 3]).

Implementations

impl CstArray

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 has_blank_line_before(&self) -> bool

Whether a blank line separates this node, and the comments written above it, from whatever came before them.

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 CstArray

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 elements(&self) -> Vec<CstNode>

Elements of the array.

pub fn append(&self, value: CstInputValue) -> CstNode

Appends an element to the end of the array.

Returns the appended node.

pub fn insert(&self, index: usize, value: CstInputValue) -> CstNode

Inserts an element at the specified index.

Returns the inserted node.

pub fn sort_elements(&self) -> ElementSort<'_>

Sorts the elements of the array.

Behaves like CstObject::sort_properties, moving what was written with an element along with it. Nothing moves until ElementSort::by or ElementSort::by_key says how to order them.

Example

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

let json_text = r#"[
  "b", // written about b
  // written about a
  "a"
]"#;

let root = CstRootNode::parse(json_text, &ParseOptions::default()).unwrap();
let array = root.array_value().unwrap();
array.sort_elements().by_key(|element| element.to_string());

assert_eq!(root.to_string(), r#"[
  // written about a
  "a",
  "b" // written about b
]"#);

pub fn ensure_multiline(&self)

Ensures the array spans multiple lines.

pub fn set_trailing_commas(&self, mode: TrailingCommaMode)

Ensures this array and all its descendants use trailing commas.

pub fn replace_with(self, replacement: CstInputValue) -> Option<CstNode>

Replaces this node with a new value.

pub fn remove(self)

Removes the node from the JSON.

pub fn to_serde_value(&self) -> Option<Value>

Converts a CST array to a serde_json::Value.

Trait Implementations

impl Clone for CstArray

fn clone(&self) -> CstArray

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CstArray

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

Formats the value using the given formatter.

impl Display for CstArray

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<CstArray> for CstContainerNode

fn from(value: CstArray) -> Self

Converts to this type from the input type.