Rust crates
This reference is generated from the doc comments (/// and //!) in the Rust sources at build time. It lists the public API of each workspace library crate: public modules, items, inherent methods and trait items. Binary crates (the server and the CLI) have no public API; see the CLI reference and the HTTP API reference.
“Public items” counts modules, items and methods. “Documented” is the part of them with a doc comment. The docs build fails when the number of public items without a doc comment grows (see apps/docs/doc-coverage.json).
| Crate | Summary | Public items | Documented |
|---|---|---|---|
calternal-api |
DTOs shared by the server and API clients. | 52 | 100% |
calternal-auth |
Authentication and session authority for a calternal instance | 186 | 44% |
calternal-collab |
Yrs XML bridge for the editor’s ProseMirror schema. | 121 | 92% |
calternal-dav |
CalDAV projection over Daily note Log entries. | 99 | 59% |
calternal-db |
SQLite storage and durable job queue for calternal | 159 | 99% |
calternal-embed |
Local ONNX embeddings and rebuildable semantic search index for calternal | 33 | 100% |
calternal-fs |
Safe, handle-relative access to a calternal data directory. | 229 | 92% |
calternal-imap |
Shared IMAP protocol boundary for Notes and Mail (#428/#486, DESIGN §§9, 53). | 88 | 95% |
calternal-location |
Store each User’s Saved places in byte-preserving Places.md and match fixes. |
14 | 57% |
calternal-media |
Bounded media-container type detection for calternal | 11 | 100% |
calternal-money |
Pure Money Markdown codec and exact envelope-budget maths for calternal (#404, #462) | 197 | 100% |
calternal-notes-core |
Pure Markdown note and daily note logic for calternal | 295 | 88% |
calternal-path |
Validated relative paths shared by the server and sync client. | 17 | 94% |
calternal-plugin |
Plugin contracts and the runtime registry. | 211 | 100% |
calternal-search |
Rebuildable Tantivy search index for calternal | 56 | 82% |
calternal-sync |
Local sync decisions are based on a durable three-way journal. | 98 | 44% |
calternal-tags |
One rebuildable tag Index over the Markdown, XMP, and folder metadata sources. | 25 | 80% |
calternal-plugin-ai |
Core AI Plugin for per-User Agent containers and undoable Agent turns. | 10 | 100% |
calternal-plugin-analytics |
Analytics Plugin: time tracked, activity counts and habits. | 2 | 100% |
calternal-plugin-calendar |
Calendar Plugin for connected CalDAV providers. | 102 | 58% |
calternal-plugin-files |
Files API. | 86 | 94% |
calternal-plugin-mail |
Mail Plugin: encrypted provider accounts and a rebuildable mailbox projection. | 33 | 70% |
calternal-plugin-money |
Money Plugin: zero-based envelope budgets in plain Markdown files (#462) | 76 | 100% |
calternal-plugin-notes |
Notes Plugin HTTP surface. | 77 | 96% |
calternal-plugin-notifications |
Web push and the in-app inbox for calternal. | 3 | 100% |
calternal-plugin-photos |
Photos keeps a rebuildable media Index keyed to Files item IDs. | 2 | 100% |
calternal-plugin-video |
Video playback with stable Files identities and rebuildable HLS renditions. | 3 | 100% |