Struct Serializer

Source

pub struct Serializer { /* private fields */ }

Expand description

Configured Serializer instance

A Serializer provides methods for converting documents to various formats using the configuration specified by the SerializerBuilder.

Implementations§

Source §

impl Serializer

Source

pub fn serialize(&self, doc: &DxDocument) -> String

Serialize a DxDocument to LLM format string

This is the primary serialization method that produces the token-efficient LLM format.

§Example

use serializer::{SerializerBuilder, DxDocument, DxLlmValue};

let mut doc = DxDocument::new();
doc.context.insert("name".to_string(), DxLlmValue::Str("MyApp".to_string()));

let serializer = SerializerBuilder::new().build();
let text = serializer.serialize(&doc);

Source

pub fn deserialize(&self, input: &str) -> Result<DxDocument, ConvertError>

Deserialize LLM format string to DxDocument

Parses the token-efficient LLM format back into a structured document.

§Errors

Returns a ConvertError if the input is not valid LLM format.

Source

pub fn format_human(&self, doc: &DxDocument) -> Result<String, PrettyPrintError>

Format a DxDocument to human-readable format

Produces clean, hand-editable format using the configured options. The output is validated if validation is enabled in the builder.

§Example

use serializer::{SerializerBuilder, DxDocument, DxLlmValue};

let mut doc = DxDocument::new();
doc.context.insert("name".to_string(), DxLlmValue::Str("MyApp".to_string()));

let serializer = SerializerBuilder::new()
    .for_humans()
    .build();
let human_text = serializer.format_human(&doc).unwrap();

Source

pub fn format_human_unchecked(&self, doc: &DxDocument) -> String

Format a DxDocument to human format without validation

Faster than format_human() but provides no guarantees about the output being parseable.

Source

pub fn generate_files( &self, doc: &DxDocument, source_path: &Path, ) -> Result<SerializerResult, SerializerOutputError>

Generate output files for a DxDocument

Creates .human and .machine files in the configured output directory.

§Example

use serializer::{SerializerBuilder, DxDocument};
use std::path::Path;

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

let result = serializer.generate_files(&doc, Path::new("config.sr")).unwrap();
println!("Generated {} bytes LLM, {} bytes machine",
         result.llm_size, result.machine_size);