Expand description
TaskPaper document parser and serializer for the doing CLI.
This crate implements the document model that backs the doing file format.
A doing file is a subset of the TaskPaper format:
sections (headers ending with :) contain entries (lines starting with - ),
each with tags (@name or @name(value)) and optional indented notes.
§Document model
Document— an ordered list ofSections with methods for querying, mutating, and persisting entries.Section— a named group of entries (e.g. “Currently”, “Done”).Entry— a single time-tracked item with a date, title,Tags, andNote.Tags— an ordered collection ofTagkey-value pairs.
§File I/O
create_file— create a new doing file with a default section.read_file— parse an on-disk file into aDocument.write_file— atomically write aDocumentback to disk.serialize— render aDocumentto its TaskPaper string representation.
Re-exports§
pub use document::Document;pub use entries::Entry;pub use io::create_file;pub use io::read_file;pub use io::write_file;pub use section::Section;pub use serializer::serialize;
Modules§
Structs§
- Note
- A multi-line note attached to a TaskPaper entry.
- Tag
- A TaskPaper tag with an optional value.
- Tags
- A collection of tags with operations for add, remove, rename, query, and dedup.
Constants§
- DEFAULT_
SECTION - The default section name used when entries appear before any section header.