Struct BasicEmitter

pub struct BasicEmitter {
    indent: usize,
    current_indent: usize,
    shared_values: HashMap<Value, ValueInfo>,
    anchor_counter: usize,
    indent_style: IndentStyle,
    yaml_version: Option<(u8, u8)>,
    tag_directives: Vec<(String, String)>,
}

Basic emitter implementation that generates clean YAML

Fields

indent: usize

current_indent: usize

shared_values: HashMap<Value, ValueInfo>

anchor_counter: usize

indent_style: IndentStyle

yaml_version: Option<(u8, u8)>

tag_directives: Vec<(String, String)>

Implementations

impl BasicEmitter

pub fn new() -> Self

Create a new emitter with default settings

pub fn with_indent(indent: usize) -> Self

Create an emitter with custom indent

pub fn with_indent_style(indent_style: IndentStyle) -> Self

Create an emitter with specific indent style

pub fn set_yaml_version(&mut self, major: u8, minor: u8)

Set the YAML version directive

pub fn add_tag_directive(&mut self, handle: String, prefix: String)

Add a TAG directive

pub fn clear_directives(&mut self)

Clear all directives

fn emit_directives<W: Write>(&self, writer: &mut W) -> Result<()>

Emit directives to the writer

fn analyze_shared_values(&mut self, value: &Value)

Analyze the value tree to identify shared values that need anchors

fn count_value_occurrences( &self, value: &Value, counts: &mut HashMap<Value, usize>, )

Recursively count occurrences of each value

const fn is_complex_value(&self, value: &Value) -> bool

Check if a value is complex enough to warrant anchor/alias handling

fn next_anchor_name(&mut self) -> String

Generate next anchor name

pub const fn set_indent_style(&mut self, indent_style: IndentStyle)

Update the indent style (useful for round-trip preservation)

fn write_indent<W: Write>(&self, writer: &mut W) -> Result<()>

Write indentation to the output

fn emit_leading_comments<W: Write>( &self, comments: &[String], writer: &mut W, ) -> Result<()>

Write leading comments to the output

fn emit_trailing_comment<W: Write>( &self, comment: &str, writer: &mut W, ) -> Result<()>

Write a trailing comment on the same line

fn emit_inner_comments<W: Write>( &self, comments: &[String], writer: &mut W, ) -> Result<()>

Write inner comments (between collection items)

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

Emit a scalar value

fn emit_scalar_with_comments<W: Write>( &self, value: &Value, comments: Option<&Comments>, writer: &mut W, ) -> Result<()>

Emit a scalar value with optional comments and style

fn emit_scalar_with_comments_and_style<W: Write>( &self, value: &Value, comments: Option<&Comments>, quote_style: Option<&QuoteStyle>, writer: &mut W, ) -> Result<()>

Emit a scalar value with optional comments and style information

fn emit_string<W: Write>(&self, s: &str, writer: &mut W) -> Result<()>

Emit a string, choosing appropriate quoting style

fn emit_string_with_style<W: Write>( &self, s: &str, preferred_style: Option<&QuoteStyle>, writer: &mut W, ) -> Result<()>

Emit a string with specific quote style

fn needs_quoting(&self, s: &str) -> bool

Check if a string needs to be quoted

fn emit_double_quoted_string<W: Write>( &self, s: &str, writer: &mut W, ) -> Result<()>

Emit a double-quoted string

fn emit_single_quoted_string<W: Write>( &self, s: &str, writer: &mut W, ) -> Result<()>

Emit a single-quoted string

fn emit_quoted_string<W: Write>(&self, s: &str, writer: &mut W) -> Result<()>

Emit a quoted string (legacy method)

fn emit_sequence<W: Write>( &mut self, seq: &[Value], writer: &mut W, ) -> Result<()>

Emit a sequence (array/list)

fn emit_mapping_with_anchor<W: Write>( &mut self, map: &IndexMap<Value, Value>, anchor: &str, writer: &mut W, ) -> Result<()>

Emit a mapping with an anchor

fn emit_mapping<W: Write>( &mut self, map: &IndexMap<Value, Value>, writer: &mut W, ) -> Result<()>

Emit a mapping (dictionary/object)

fn emit_mapping_flow_style<W: Write>( &self, map: &IndexMap<Value, Value>, writer: &mut W, ) -> Result<()>

Emit a mapping in flow style for complex keys

fn emit_sequence_flow_style<W: Write>( &self, seq: &[Value], writer: &mut W, ) -> Result<()>

Emit a sequence in flow style for complex keys

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

Emit any value, dispatching to the appropriate method with anchor/alias support

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

Emit any value (old method for backwards compatibility)

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

Emit a commented value with full comment and style support

Trait Implementations

impl Debug for BasicEmitter

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

Formats the value using the given formatter.

impl Default for BasicEmitter

fn default() -> Self

Returns the “default value” for a type.

impl Emitter for BasicEmitter

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

Emit a value to the output

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

Emit a commented value to the output with comment preservation

fn emit_with_style<W: Write>( &mut self, value: &CommentedValue, indent_style: &IndentStyle, writer: W, ) -> Result<()>

Emit a commented value with specific indent style

fn reset(&mut self)

Reset the emitter state