Struct YamlFile 

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

A YAML file containing one or more documents

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 YamlFile

pub fn new() -> YamlFile

Create a new empty YAML document.

pub fn parse(text: &str) -> Parse<YamlFile>

Parse YAML text, returning a Parse result

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<YamlFile, YamlError>

Parse YAML from a file path

pub fn documents(&self) -> impl Iterator<Item = Document>

Get all documents in this YAML file

pub fn document(&self) -> Option<Document>

Get the first document in this YAML file, or None if there are none.

Most YAML files have exactly one document. Use documents to iterate over all documents in a multi-document file.

pub fn ensure_document(&self) -> Document

Ensure this YamlFile contains at least one document, creating an empty mapping document if needed.

Returns the first document.

pub fn directives(&self) -> impl Iterator<Item = Directive>

Iterate over all YAML directives (e.g. %YAML 1.2) in this file.

pub fn add_directive(&self, directive_text: &str)

Prepend a YAML directive to this file.

directive_text should be the full directive line without a trailing newline, e.g. "%YAML 1.2" or "%TAG ! tag:example.com,2000:app/". The directive is inserted before all existing content.

Note: the parser does not currently enforce that directives appear before any document node; callers are responsible for ordering.

pub fn push_document(&self, document: Document)

Add a new document to the end of this YAML file

pub fn set(&self, key: impl AsYaml, value: impl AsYaml)

Set a key-value pair in the first document’s mapping.

If the key exists its value is replaced; if not, a new entry is appended. Does nothing if the YamlFile contains no documents or the first document is not a mapping. Use ensure_document first if you need to guarantee a document exists.

Mutates in place despite &self (see crate docs on interior mutability).

pub fn insert_after( &self, after_key: impl AsYaml, key: impl AsYaml, value: impl AsYaml, ) -> bool

Insert a key-value pair immediately after after_key in the first document.

Delegates to Document::insert_after, which in turn calls Mapping::insert_after. If key already exists it is updated in-place rather than moved. Returns false if after_key is not found or the document is not a mapping.

Mutates in place despite &self (see crate docs on interior mutability).

pub fn insert_before( &self, before_key: impl AsYaml, key: impl AsYaml, value: impl AsYaml, ) -> bool

Insert a key-value pair immediately before before_key in the first document.

Delegates to Document::insert_before, which in turn calls Mapping::insert_before. If key already exists it is updated in-place rather than moved. Returns false if before_key is not found or the document is not a mapping.

Mutates in place despite &self (see crate docs on interior mutability).

pub fn move_after( &self, after_key: impl AsYaml, key: impl AsYaml, value: impl AsYaml, ) -> bool

Move a key-value pair to immediately after after_key in the first document.

Delegates to Document::move_after. If key already exists it is removed from its current position and re-inserted after after_key. Returns false if after_key is not found or the document is not a mapping.

Use insert_after if you want an existing entry to be updated in-place rather than moved.

Mutates in place despite &self (see crate docs on interior mutability).

pub fn move_before( &self, before_key: impl AsYaml, key: impl AsYaml, value: impl AsYaml, ) -> bool

Move a key-value pair to immediately before before_key in the first document.

Delegates to Document::move_before. If key already exists it is removed from its current position and re-inserted before before_key. Returns false if before_key is not found or the document is not a mapping.

Use insert_before if you want an existing entry to be updated in-place rather than moved.

Mutates in place despite &self (see crate docs on interior mutability).

pub fn insert_at_index( &self, index: usize, key: impl AsYaml, value: impl AsYaml, )

Insert a key-value pair at a specific index (0-based) in the first document.

Delegates to Document::insert_at_index. If key already exists it is updated in-place rather than moved. If index is out of bounds the entry is appended at the end. If the document has no mapping yet, one is created automatically. This method always succeeds; it never returns an error.

Mutates in place despite &self (see crate docs on interior mutability).

Trait Implementations

impl AstNode for YamlFile

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 YamlFile

fn clone(&self) -> YamlFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for YamlFile

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

Formats the value using the given formatter.

impl Default for YamlFile

fn default() -> Self

Returns the “default value” for a type.

impl Display for YamlFile

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

Formats the value using the given formatter.

impl FromStr for YamlFile

type Err = YamlError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for YamlFile

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 YamlFile

fn eq(&self, other: &YamlFile) -> 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 YamlAccept for YamlFile

fn accept<V: YamlVisitor>(&self, visitor: &mut V)

Accept a visitor for traversal

impl Eq for YamlFile

impl StructuralPartialEq for YamlFile