Struct SerializerBuilder 

pub struct SerializerBuilder { /* private fields */ }

Builder for configuring serialization options

The SerializerBuilder provides a fluent API for customizing serialization behavior. It combines configuration from multiple internal types into a single, easy-to-use interface.

Implementations

impl SerializerBuilder

pub fn new() -> Self

Create a new SerializerBuilder with default settings

pub fn indent_size(self, size: usize) -> Self

Set the indentation size for formatted output

Controls the minimum padding for keys in human format. Set to 0 for no padding (default).

Example

use serializer::SerializerBuilder;

let serializer = SerializerBuilder::new()
    .indent_size(4)
    .build();

pub fn expand_keys(self, expand: bool) -> Self

Set whether to expand abbreviated keys to full names

When true (default), keys like “nm” become “name” in human format. When false, abbreviated keys are preserved.

Example

use serializer::SerializerBuilder;

let serializer = SerializerBuilder::new()
    .expand_keys(false)  // Keep "nm" instead of expanding to "name"
    .build();

pub fn use_list_format(self, use_list: bool) -> Self

Set whether to use list format for arrays

When true (default), arrays are formatted as:

items:
- first
- second

When false, arrays are formatted inline:

items = first | second

pub fn space_around_equals(self, space: bool) -> Self

Set whether to add spaces around equals signs

When true (default): key = value When false: key=value

pub fn validate_output(self, validate: bool) -> Self

Set whether to validate output by parsing it back

When enabled, the serializer will parse the formatted output to ensure it’s valid. This catches formatting bugs but is slower.

Note: Currently disabled by default since V3 format round-trip is not fully implemented.

pub fn check_round_trip(self, check: bool) -> Self

Set whether to check round-trip consistency

When enabled (requires validate_output), the serializer will verify that parsing the formatted output produces an equivalent document to the original.

pub fn output_dir<P: Into<PathBuf>>(self, dir: P) -> Self

Set the output directory for generated files

When set, the serializer can generate .human and .machine files in the specified directory. Default is “.dx/serializer”.

Example

use serializer::SerializerBuilder;

let serializer = SerializerBuilder::new()
    .output_dir("build/serializer")
    .build();

pub fn generate_llm(self, generate: bool) -> Self

Set whether to generate LLM format files

When true (default), .llm files are generated in .dx/serializer.

pub fn generate_machine(self, generate: bool) -> Self

Set whether to generate machine format files

When true (default), .machine files are generated for runtime use.

pub fn preserve_comments(self, preserve: bool) -> Self

Set whether to preserve comments in output

Note: Comment preservation is not yet fully implemented. This option is reserved for future use.

pub fn compact_arrays(self, compact: bool) -> Self

Set whether to use compact array formatting

When true, arrays are formatted more compactly. This is equivalent to setting use_list_format(false).

pub fn for_tables(self) -> Self

Create a configuration optimized for tables and rules

This preset is useful for multi-row sections like lint rules. It sets appropriate padding and formatting for tabular data.

Example

use serializer::SerializerBuilder;

let serializer = SerializerBuilder::new()
    .for_tables()
    .build();

pub fn for_compact(self) -> Self

Create a configuration optimized for compact output

This preset minimizes whitespace and uses abbreviated keys. Useful for token-efficient LLM format.

pub fn for_humans(self) -> Self

Create a configuration optimized for human readability

This preset maximizes readability with expanded keys, proper spacing, and list formatting for arrays.

pub fn build(self) -> Serializer

Build the configured Serializer

Creates a Serializer instance with all the specified options.

Trait Implementations

impl Clone for SerializerBuilder

fn clone(&self) -> SerializerBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SerializerBuilder

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

Formats the value using the given formatter.

impl Default for SerializerBuilder

fn default() -> Self

Returns the “default value” for a type.