Struct SerializerOptions 

pub struct SerializerOptions {
    pub empty_as_braces: bool,
    pub indent_step: usize,
    pub anchor_generator: Option<fn(usize) -> String>,
    pub min_fold_chars: usize,
    pub folded_wrap_chars: usize,
    pub tagged_enums: bool,
    pub prefer_block_scalars: bool,
    pub quote_all: bool,
    pub yaml_12: bool,
}

Serializer options for YAML emission.

This struct controls various aspects of YAML serialization, such as indentation, anchor generation, and scalar styles.

Construct SerializerOptions using the ser_options! macro to ensure compatibility with future updates.

use serde::Serialize;
use serde_saphyr::{ser_options, to_string_with_options};

#[derive(Serialize)]
struct Config {
    name: String,
    values: Vec<i32>,
}

let config = Config {
    name: "test".to_string(),
    values: vec![1, 2, 3],
};

// Use 4-space indentation and quote all strings
let options = ser_options! {
    indent_step: 4,
    quote_all: true,
};

let yaml = to_string_with_options(&config, options).unwrap();

Fields

empty_as_braces: bool

If true, empty maps are emitted as braces {} and empty lists as [] (this is the default). Such form is equally valid YAML, allows to tell empty from null and may be easier for a human to grasp.

indent_step: usize

Number of spaces to indent per nesting level when emitting block-style collections (2 by default). 0 value is invalid and will result and error when trying to deserialize, because no indentation would produce invalid YAML otherwise.

anchor_generator: Option<fn(usize) -> String>

Optional custom anchor-name generator.

Receives a monotonically increasing usize id (starting at 1) and returns the anchor name to emit. If None, the built-in generator yields names like a1, a2, …

min_fold_chars: usize

Threshold for block-string wrappers (crate::LitStr/crate::FoldStr and owned variants crate::LitString/crate::FoldString).

If the string contains a newline, block style is always used. Otherwise, when the string is single-line and its length is strictly less than this threshold, the serializer emits a normal YAML scalar (no block style). Longer strings use block styles | or > depending on the wrapper. See the type docs for crate::LitStr, crate::FoldStr, crate::LitString and crate::FoldString for examples.

folded_wrap_chars: usize

Maximum width (in characters) for lines in folded block scalars (>).

Lines are wrapped only at whitespace so that each emitted line is at most this many characters long (excluding indentation). If no whitespace is present within the limit (e.g., a single long token), the line is emitted unwrapped to preserve round-trip correctness: YAML folded scalars typically fold inserted newlines back as spaces when parsing. 32 default.

tagged_enums: bool

When enabled, serialize simple enums that become a single scalar (unit variants) using YAML tags, e.g. !!Enum Variant instead of a plain scalar Variant. Deserializer does not need this setting as both cases will be understood. Off by default.

prefer_block_scalars: bool

When enabled, strings containing more than folded_wrap_chars (80 by default) are written in wrapped multistring folded form (>), and strings containing new lines are written in literal form (|), selecting format depending on the number of empty lines at the end. On by default.

quote_all: bool

When enabled, quote all string scalars. Uses single quotes by default, but switches to double quotes when the string contains escape sequences (control characters like \n, \t, \r, backslash) or single quotes. Disables block scalar styles (| and >) for quoted strings when active. Off by default.

yaml_12: bool

When enabled, emit %YAML 1.2 at the beginning of the document and use YAML 1.2 rules for certain compatibility heuristics.

In particular, YAML 1.1 boolean spellings like yes/no/on/off/y/n will not be treated as booleans for the purpose of auto-quoting. In cases like multiple x, y coordinates quoting y may be very annoying. Default: false.

Trait Implementations

impl Clone for SerializerOptions

fn clone(&self) -> SerializerOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for SerializerOptions

fn default() -> Self

Returns the “default value” for a type.

impl Copy for SerializerOptions