Skip to main content

Crate doing_taskpaper

Crate doing_taskpaper 

Source
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 of Sections 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, and Note.
  • Tags — an ordered collection of Tag key-value pairs.

§File I/O

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§

document
entries
io
section
serializer

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.