Struct DxDocument 

pub struct DxDocument {
    pub context: IndexMap<String, DxLlmValue>,
    pub refs: IndexMap<String, String>,
    pub sections: IndexMap<char, DxSection>,
    pub section_names: IndexMap<char, String>,
    pub entry_order: Vec<EntryRef>,
}

Top-level document container for the DX LLM format.

A DxDocument represents a complete DX document in the LLM format, containing context configuration, reference definitions, and data sections.

Structure

#c context_key=value          // Context section
#: ref_key=ref_value          // Reference definitions
#d(id,name)[                  // Data section 'd' with schema
  1,Alice
  2,Bob
]

Examples

Creating a Document

use serializer::llm::{DxDocument, DxSection, DxLlmValue};

let mut doc = DxDocument::new();

// Add context
doc.context.insert("version".to_string(), DxLlmValue::Str("1.0".to_string()));

// Add a reference
doc.refs.insert("company".to_string(), "Acme Corp".to_string());

// Add a data section
let mut section = DxSection::new(vec!["id".to_string(), "name".to_string()]);
section.add_row(vec![DxLlmValue::Num(1.0), DxLlmValue::Str("Alice".to_string())]).unwrap();
doc.sections.insert('d', section);

Thread Safety

DxDocument implements Send + Sync and can be safely shared between threads for concurrent read access. For mutation, use appropriate synchronization.

See Also

• DxSection - Data section with schema and rows
• DxLlmValue - Value type for section data

Fields

context: IndexMap<String, DxLlmValue>

Context/config section (#c).

Contains configuration key-value pairs that apply to the entire document.

refs: IndexMap<String, String>

Reference definitions (#:).

Defines reusable string values that can be referenced with ^key syntax. This enables deduplication of repeated values for token efficiency.

sections: IndexMap<char, DxSection>

Data sections (#<letter>).

Each section is identified by a single character (e.g., ‘d’ for #d). Sections contain tabular data with a schema and rows.

section_names: IndexMap<char, String>

Section names mapping (char ID -> full name like “dependencies”)

Maps single-character section IDs to their full names for human-readable output.

entry_order: Vec<EntryRef>

Entry order tracking

Tracks the order of all entries (context keys and section IDs) as they appear in the original document. Each entry is either a context key or a section ID.

Implementations

impl DxDocument

pub fn new() -> Self

Create a new empty document

pub fn is_empty(&self) -> bool

Check if the document is empty

pub fn get_path(&self, path: &str) -> Option<&DxLlmValue>

Get a value by canonical LLM path.

This supports both root keys (project) and object paths (project.name) where the root value is an inline object such as project(name=dx-devtools version=0.1.0).

pub fn section_by_name(&self, name: &str) -> Option<&DxSection>

Find a wrapped dataframe/table section by its full section name.

Trait Implementations

impl Clone for DxDocument

fn clone(&self) -> DxDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DxDocument

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

Formats the value using the given formatter.

impl Default for DxDocument

fn default() -> Self

Returns the “default value” for a type.

impl From<&DxDocument> for MachineDocument

fn from(doc: &DxDocument) -> Self

Converts to this type from the input type.

impl From<&MachineDocument> for DxDocument

fn from(m: &MachineDocument) -> Self

Converts to this type from the input type.

impl PartialEq for DxDocument

fn eq(&self, other: &DxDocument) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DxDocument