agent_first_data/document/
mod.rs

1//! Format-independent document values: dot-path get/set/add/remove, type-directed
2//! CLI-string coercion, keyed-list (slug-addressed array) helpers, and typed
3//! serde adapters, backed by pluggable JSON/TOML/YAML/dotenv/INI format readers
4//! and writers, plus a read-only CommonMark block reader.
5//!
6//! # Features
7//!
8//! JSON support is always compiled in — `agent_first_data` already depends on
9//! `serde_json` as a core dependency.
10//!
11//! - **toml**: Enable TOML format support (format-preserving with toml_edit)
12//! - **yaml**: Enable YAML format support with CST-backed source-preserving mutation
13//! - **dotenv**: Enable source-preserving dotenv format support
14//! - **ini**: Enable INI Core v1 format support
15//! - **markdown**: Enable the read-only CommonMark block reader
16//! - **schema**: Enable the `CliSchema` trait and documentation rendering
17//! - **libc**: Enable nonblocking and atomic no-follow document opens on unix
18//!
19//! This module never redacts values on decode/encode/save — it returns and
20//! saves raw values as-is; redaction is the caller's responsibility.
21
22pub mod coerce;
23pub mod error;
24pub mod file;
25pub mod keyed;
26pub mod path;
27pub mod traverse;
28pub mod typed;
29pub mod value;
30
31pub mod format;
32
33#[cfg(feature = "schema")]
34pub mod schema;
35
36pub use crate::atomic_file::{AtomicError, AtomicStep, write_atomic};
37pub use coerce::{
38    BareOverwrite, ScalarKind, ValueType, coerce_toward, coerce_values_toward,
39    guard_bare_overwrite, scalar_kind, value_from_type, value_matches_type,
40};
41pub use error::{DocumentError, DocumentResult};
42pub use file::{CreateMode, CreateOptions, Document, DocumentFile, SymlinkPolicy};
43pub use keyed::{Addressing, ArrayRule, KeyedList, MatchKind, add_keyed, remove_keyed};
44pub use path::{PatternSegment, join_path, parse_path, parse_path_pattern};
45pub(crate) use traverse::{append_position_refused, keyed_prefix_matches};
46pub use traverse::{get_path, get_path_ref, resolve_path, set_path, unset_path};
47pub use typed::{from_value, to_value};
48pub use value::Value;
49
50pub use format::Format;
51
52#[cfg(feature = "schema")]
53pub use schema::{
54    CliSchema, FieldDef, render_annotated_toml, render_annotated_yaml, render_doc_markdown,
55};
agent_first_data/document/mod.rs

agent_first_data/document/
mod.rs
