Module okf

Module okf 

Source
Expand description

The canonical memory format: human-readable OKF Markdown.

The durable asset is the corpus, not the index. A user’s memory is a set of Markdown files they can read, diff, hand-edit and delete; every retrieval structure in this crate is derived from them and can be rebuilt from scratch.

Re-exports§

pub use document::OkfDocument;
pub use record::OKF_VERSION;
pub use record::from_document;
pub use record::to_document;
pub use repository::MANIFEST_SCHEMA_VERSION;
pub use repository::ManifestEntry;
pub use repository::MemoryManifest;
pub use repository::MemoryRepository;
pub use repository::MemoryTransaction;
pub use repository::MemoryWrite;
pub use repository::OkfRepository;
pub use repository::ReconciliationSelector;
pub use repository::Tombstone;
pub use repository::category_path;
pub use store::FsStore;
pub use store::MemoryStore;
pub use store::OkfStore;
pub use yaml::Yaml;
pub use yaml::YamlError;

Modules§

document
The OKF document container: YAML front matter plus Markdown body sections.
record
Mapping between CanonicalMemory and its on-disk OKF representation.
repository
The canonical memory repository.
store
The byte-level store the OKF repository is projected onto.
yaml
A strict YAML subset for OKF front matter.