Struct Yaml 

pub struct Yaml {
    config: YamlConfig,
}

Main YAML processing interface

Fields

config: YamlConfig

Implementations

impl Yaml

pub fn new() -> Self

Create a new YAML processor with default configuration

pub fn with_loader(loader_type: LoaderType) -> Self

Create a new YAML processor with the specified loader type

pub const fn with_config(config: YamlConfig) -> Self

Create a new YAML processor with custom configuration

pub const fn config(&self) -> &YamlConfig

Get the current configuration

pub const fn config_mut(&mut self) -> &mut YamlConfig

Get a mutable reference to the configuration

pub fn load_str(&self, input: &str) -> Result<Value>

Load YAML from a string

pub fn load<R: Read>(&self, reader: R) -> Result<Value>

Load YAML from a reader

pub fn load_all_str(&self, input: &str) -> Result<Vec<Value>>

Load all YAML documents from a string

pub fn load_all<R: Read>(&self, reader: R) -> Result<Vec<Value>>

Load all YAML documents from a reader

pub fn dump_str(&self, value: &Value) -> Result<String>

Dump a YAML value to a string

pub fn dump<W: Write>(&self, value: &Value, writer: W) -> Result<()>

Dump a YAML value to a writer

pub fn dump_all_str(&self, values: &[Value]) -> Result<String>

Dump all YAML documents to a string

pub fn dump_all<W: Write>(&self, values: &[Value], writer: W) -> Result<()>

Dump all YAML documents to a writer

pub fn load_str_with_comments(&self, input: &str) -> Result<CommentedValue>

Load YAML from a string with comment preservation (RoundTrip mode only)

pub fn dump_str_with_comments(&self, value: &CommentedValue) -> Result<String>

Dump a CommentedValue to a string, preserving comments

pub fn dump_with_comments<W: Write>( &self, value: &CommentedValue, writer: W, ) -> Result<()>

Dump a CommentedValue to a writer, preserving comments

pub fn validate_with_schema(&self, value: &Value, schema: &Schema) -> Result<()>

Validate a YAML value against a schema

pub fn load_str_with_schema( &self, input: &str, schema: &Schema, ) -> Result<Value>

Load and validate YAML from a string with schema validation

pub fn load_all_str_with_schema( &self, input: &str, schema: &Schema, ) -> Result<Vec<Value>>

Load and validate all YAML documents from a string with schema validation

fn parse_yaml_string(&self, input: &str) -> Result<Value>

fn parse_yaml_documents(&self, input: &str) -> Result<Vec<Value>>

fn emit_yaml_value<W: Write>(&self, value: &Value, writer: W) -> Result<()>

fn parse_yaml_string_with_comments(&self, input: &str) -> Result<CommentedValue>

fn emit_commented_value<W: Write>( &self, value: &CommentedValue, writer: W, ) -> Result<()>

fn emit_yaml_documents<W: Write>( &self, values: &[Value], writer: W, ) -> Result<()>

Trait Implementations

impl Clone for Yaml

fn clone(&self) -> Yaml

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Yaml

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

Formats the value using the given formatter.

impl Default for Yaml

fn default() -> Self

Returns the “default value” for a type.