Struct MappingEntry 

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

A key-value pair in a YAML mapping

Note: This type uses interior mutability through the rowan library. Mutation methods work even when called through &self. See the crate-level documentation for details on the mutability model.

Implementations

impl MappingEntry

pub fn key_matches(&self, key: impl AsYaml) -> bool

Return true if the key of this entry matches key.

Uses semantic YAML equality, so quoting style differences are ignored: "foo", 'foo', and foo all match the scalar "foo". Returns false if this entry has no key node.

pub fn key_node(&self) -> Option<YamlNode>

Get the key of this entry as a YamlNode.

Returns None for malformed entries that have no key.

pub fn value_node(&self) -> Option<YamlNode>

Get the value of this entry as a YamlNode.

Returns None for malformed entries that have no value.

pub fn new( key: impl AsYaml, value: impl AsYaml, flow_context: bool, use_explicit_key: bool, ) -> Self

Create a new mapping entry (key-value pair) not yet attached to any mapping.

The entry is built as a standalone CST node; attach it to a mapping with one of the insert_* methods. Block-style values (mappings, sequences) are indented with 2 spaces relative to the key.

pub fn set_value(&self, new_value: impl AsYaml, flow_context: bool)

Replace the value of this entry in place, preserving the key and surrounding whitespace.

pub fn discard(self)

Detach this entry from its parent mapping, effectively removing it.

The entry node is detached from the tree; the MappingEntry value is consumed. To retrieve the removed entry from a mapping (and get back a MappingEntry you can inspect), use Mapping::remove instead.

pub fn remove(self)

Remove this entry from its parent mapping.

This is a convenience method that calls discard internally. It’s useful when you have a MappingEntry (e.g., from find_all_entries_by_key) and want to remove it without retrieving it from the mapping again.

Consumes self and detaches the entry from the parent mapping.

Trait Implementations

impl AstNode for MappingEntry

type Language = Lang

fn can_cast(kind: SyntaxKind) -> bool

fn cast(syntax: SyntaxNode<Lang>) -> Option<Self>

fn syntax(&self) -> &SyntaxNode<Lang>

fn clone_for_update(&self) -> Self

where Self: Sized,

fn clone_subtree(&self) -> Self

where Self: Sized,

impl Clone for MappingEntry

fn clone(&self) -> MappingEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MappingEntry

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

Formats the value using the given formatter.

impl Display for MappingEntry

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

Formats the value using the given formatter.

impl Hash for MappingEntry

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MappingEntry

fn eq(&self, other: &MappingEntry) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for MappingEntry

impl StructuralPartialEq for MappingEntry