API Reference

The full Rust API documentation is generated by cargo doc and hosted alongside these docs.

View API Reference

Key public types

For a v1.0 GUI / library consumer, the most important types to know about:

• SyncReport — return shape of the full sync() pipeline (reconcile → discover → consolidate → distribute → cleanup → save). Primary data source for any “what happened this sync” surface.
• reconcile::ReconcileReport — outcome of one reconcile pass (Match / Drift / Vanished / Missing classifications plus edit-in-library user decisions).
• marketplace::MarketplaceAdapter — pluggable trait for managed-skill install/update/availability. Two production implementations ship (ClaudeMarketplaceAdapter, GitAdapter); third-party adapters can implement the trait directly (sealing is tracked as a v1.0 follow-up in #518).
• CleanupResult — bucket-by-bucket cleanup outcomes (removed-from-config / missing-from-disk / now-in-exclude-list). Accessors are read-only; the renderer owns the user-facing surface.
• status::StatusReport + status::DirectoryStatus — tome status --json shape. Since v0.12.0, DirectoryStatus.role is the typed DirectoryRole enum (with the human-readable description in a separate role_description field).
• doctor::DoctorReport — tome doctor --json shape, including IssueCategory (Library / Directory / Config / Foreign-symlink) groupings.

The architecture narrative — how these types fit together, why the library is canonical, how reconcile interacts with the manifest and lockfile — lives in Architecture.

Newtypes

Domain-specific wrappers with validation at construction:

• SkillName — validated skill identifier
• config::DirectoryName — validated directory entry name
• validation::ContentHash — SHA-256 of a skill directory, normalized to lowercase hex
• paths::TomePaths — bundle of tome_home / library_dir / config_dir to prevent parameter-order bugs