Struct SerializerConfig 

#[non_exhaustive]
pub struct SerializerConfig {

    pub indent: usize,
    pub document_start: bool,
    pub document_end: bool,
    pub block_scalars: bool,
    pub block_scalar_threshold: usize,
    pub flow_style: FlowStyle,
    pub scalar_style: ScalarStyle,
    pub flow_threshold: usize,
    pub quote_all: bool,
    pub compact_list_indent: bool,
    pub folded_wrap_chars: usize,
    pub min_fold_chars: usize,
    pub max_depth: usize,
}

Configuration options for YAML serialization.

Examples

use noyalib::{FlowStyle, ScalarStyle, SerializerConfig};

let config = SerializerConfig::new()
    .indent(4)
    .flow_style(FlowStyle::Auto)
    .scalar_style(ScalarStyle::DoubleQuoted)
    .document_start(true);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

indent: usize

Number of spaces per indentation level (default: 2).

document_start: bool

Whether to include document start marker --- (default: false).

document_end: bool

Whether to include document end marker ... (default: false).

block_scalars: bool

Whether to use block style for multiline strings (default: true).

block_scalar_threshold: usize

Minimum number of newlines to trigger block scalar style (default: 1).

flow_style: FlowStyle

Flow style preference for collections (default: Block).

scalar_style: ScalarStyle

Scalar style preference for strings (default: Auto).

flow_threshold: usize

Maximum number of items in a collection to use flow style in Auto mode (default: 4).

quote_all: bool

Force-quote all string scalars regardless of content (default: false).

compact_list_indent: bool

Compact list indentation under mapping keys (default: false).

When true, sequence items under a mapping key align with the key instead of being indented an extra level.

folded_wrap_chars: usize

Line width for folded block scalars (default: 80).

min_fold_chars: usize

Minimum string length before block scalar style is considered (default: 80).

max_depth: usize

Maximum nesting depth allowed during serialization (default: 128).

Implementations

impl SerializerConfig

pub fn new() -> Self

Create a new configuration with default settings.

pub fn indent(self, spaces: usize) -> Self

Set the indentation width.

pub fn document_start(self, enabled: bool) -> Self

Enable or disable document start marker ---.

pub fn document_end(self, enabled: bool) -> Self

Enable or disable document end marker ....

pub fn block_scalars(self, enabled: bool) -> Self

Enable or disable block scalar style for multiline strings.

pub fn block_scalar_threshold(self, count: usize) -> Self

Set minimum newlines to trigger block scalar style.

pub fn flow_style(self, style: FlowStyle) -> Self

Set the flow style preference for collections.

• FlowStyle::Block: Always use multi-line block style
• FlowStyle::Flow: Always use inline flow style
• FlowStyle::Auto: Use flow for small collections

pub fn scalar_style(self, style: ScalarStyle) -> Self

Set the scalar style preference for strings.

• ScalarStyle::Auto: Quote only when necessary
• ScalarStyle::DoubleQuoted: Always use double quotes
• ScalarStyle::SingleQuoted: Always use single quotes
• ScalarStyle::Literal: Use | for multiline
• ScalarStyle::Folded: Use > for multiline
• ScalarStyle::Plain: Unquoted when possible

pub fn flow_threshold(self, threshold: usize) -> Self

Set the threshold for automatic flow style.

Collections with this many or fewer items will use flow style when flow_style is set to Auto.

pub fn quote_all(self, enabled: bool) -> Self

Force-quote all string scalars regardless of content.

pub fn compact_list_indent(self, enabled: bool) -> Self

Enable compact list indentation under mapping keys.

When enabled, sequence items align with the key rather than being indented an extra level.

pub fn folded_wrap_chars(self, chars: usize) -> Self

Set the line width for folded block scalars.

pub fn min_fold_chars(self, chars: usize) -> Self

Set the minimum string length for block scalar style.

Strings shorter than this threshold will not use block scalar (| / >) style, even if they contain newlines.

pub fn max_depth(self, depth: usize) -> Self

Set the maximum nesting depth for serialization.

Trait Implementations

impl Clone for SerializerConfig

fn clone(&self) -> SerializerConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SerializerConfig

impl Debug for SerializerConfig

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

Formats the value using the given formatter.

impl Default for SerializerConfig

fn default() -> Self

Returns the “default value” for a type.