Struct Document 

pub struct Document { /* private fields */ }

A complete TaskPaper doing file represented as an ordered list of sections.

The document preserves section ordering from the original file and can track non-entry content at the top and bottom of the file for round-trip fidelity.

Implementations

impl Document

pub fn create_file(path: &Path, default_section: &str) -> Result<()>

Create a new doing file at path with a single default section.

If the file already exists and is non-empty, this is a no-op. Creates parent directories as needed.

pub fn new() -> Self

Create a new empty document.

pub fn parse(content: &str) -> Self

Parse a doing file string into a structured Document.

pub fn add_section(&mut self, section: Section)

Add a section to the document. Does nothing if a section with the same name (case-insensitive) already exists.

pub fn all_entries(&self) -> Vec<&Entry>

Return all entries across all sections.

pub fn dedup(&mut self)

Deduplicate entries across all sections by ID, keeping the first occurrence.

pub fn entries_in_section(&self, name: &str) -> Vec<&Entry>

Return entries from a specific section by name (case-insensitive). If name is “all” (case-insensitive), returns entries from all sections.

pub fn has_section(&self, name: &str) -> bool

Return true if a section with the given name exists (case-insensitive).

pub fn is_empty(&self) -> bool

Return true if the document has no sections.

pub fn len(&self) -> usize

Return the number of sections in the document.

pub fn other_content_bottom(&self) -> &[String]

Return non-entry content from the bottom of the file.

pub fn other_content_bottom_mut(&mut self) -> &mut Vec<String>

Return a mutable reference to non-entry content from the bottom of the file.

pub fn other_content_top(&self) -> &[String]

Return non-entry content from the top of the file.

pub fn other_content_top_mut(&mut self) -> &mut Vec<String>

Return a mutable reference to non-entry content from the top of the file.

pub fn remove_section(&mut self, name: &str) -> usize

Remove a section by name (case-insensitive), returning the number removed.

pub fn section_by_name(&self, name: &str) -> Option<&Section>

Look up a section by name (case-insensitive).

pub fn section_by_name_mut(&mut self, name: &str) -> Option<&mut Section>

Look up a mutable section by name (case-insensitive).

pub fn sections(&self) -> &[Section]

Return a slice of all sections.

pub fn sections_mut(&mut self) -> &mut Vec<Section>

Return a mutable reference to all sections.

pub fn sort_entries(&mut self, reverse: bool)

Sort entries within each section by date then title, in ascending order. If reverse is true, sort in descending order.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Document

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Document

fn default() -> Self

Returns the “default value” for a type.

impl Display for Document

fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult

Format as a complete TaskPaper doing file.