Struct CstObject

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

Object literal that may contain properties (ex. {}, { "prop": 4 }).

Implementations

impl CstObject

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 CstObject

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 array_value(&self, name: &str) -> Option<CstArray>

Array property by name.

Returns None if the property doesn’t exist or is not an array.

pub fn array_value_or_create(&self, name: &str) -> Option<CstArray>

Ensures a property exists with an array value returning the array.

Returns None if the property value exists, but is not an array.

Note: Use .array_value_or_set(..) to overwrite an existing non-array property value.

pub fn array_value_or_set(&self, name: &str) -> CstArray

Ensures a property exists with an array value returning the array.

Note: Use .array_value_or_create(..) to not overwrite an existing non-array property value.

pub fn object_value(&self, name: &str) -> Option<CstObject>

Object property by name.

Returns None if the property doesn’t exist or is not an object.

pub fn object_value_or_create(&self, name: &str) -> Option<CstObject>

Ensures a property exists with an object value returning the object.

Returns None if the property value exists, but is not an object.

Note: Use .object_value_or_set(..) to overwrite an existing non-array property value.

pub fn object_value_or_set(&self, name: &str) -> CstObject

Ensures a property exists with an object value returning the object.

Note: Use .object_value_or_create(..) to not overwrite an existing non-object property value.

pub fn get(&self, name: &str) -> Option<CstObjectProp>

Property by name.

Returns None if the property doesn’t exist.

pub fn properties(&self) -> Vec<CstObjectProp>

Properties of the object.

pub fn append(&self, prop_name: &str, value: CstInputValue) -> CstObjectProp

Appends a property to the object.

Returns the inserted object property.

pub fn insert( &self, index: usize, prop_name: &str, value: CstInputValue, ) -> CstObjectProp

Inserts a property at the specified index.

Returns the inserted object property.

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

Replaces this node with a new value.

pub fn set_trailing_commas(&self, mode: TrailingCommaMode)

Ensures this object and all its descendants use trailing commas.

pub fn ensure_multiline(&self)

Ensures the object spans multiple lines.

pub fn remove(self)

Removes the node from the JSON.

Trait Implementations

impl Clone for CstObject

fn clone(&self) -> CstObject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CstObject

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

Formats the value using the given formatter.

impl Display for CstObject

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

Formats the value using the given formatter.

impl From<CstObject> for CstContainerNode

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