Struct IssueDoc 

pub struct IssueDoc {
    pub project: String,
    pub path: PathBuf,
    pub preamble: String,
    pub tag_settings: TagSettings,
    pub headings: Vec<IssueHeading>,
    /* private fields */
}

One project’s issues.org: a preamble followed by top-level headings.

Fields

project: String

Project directory name this file belongs to.

path: PathBuf

Path of the issues.org this document was parsed from or will write to.

preamble: String

File header above the first heading, including #+TODO:.

tag_settings: TagSettings

#+FILETAGS:, #+TAGS:, and export tag keywords from the preamble.

headings: Vec<IssueHeading>

Top-level issue headings, in file order.

Implementations

impl IssueDoc

pub fn empty(project: &str, path: PathBuf) -> Self

An empty document with the house preamble and no headings.

pub fn parse_file(project: &str, path: &Path) -> Result<Self>

Parse path, or produce an empty document when the file is absent.

Errors

Returns an error if the file exists but cannot be read or parsed.

pub fn parse(project: &str, path: PathBuf, content: &str) -> Result<Self>

Parse content as an issues.org for project.

Errors

Returns an error if an issue heading has no :ID:. A heading whose first word is not a TODO keyword is Org around the issues, not a failed parse.

pub fn render_string(&self) -> String

The file body this document would write.

pub fn write(&self) -> Result<()>

Render and replace the file through a uniquely named temporary. Callers hold with_issues_lock around the parse and this write.

Errors

Returns an error if the parent directory cannot be created, the temporary cannot be written, or the rename cannot publish it.

pub fn priority_spec(&self) -> PrioritySpec

#+PRIORITIES: from this file and any local #+SETUPFILE:.

pub fn priorities_are_named(&self) -> bool

Whether the file or a local setupfile names #+PRIORITIES:.

pub fn default_create_priority(&self, cfg_default: char) -> char

Cookie for a new heading: the file default when named, else cfg_default.

pub fn known_ids(&self) -> Vec<String>

Every heading id in this document, in file order.

pub fn upsert(&mut self, heading: IssueHeading)

Replace a heading with the same id, or append if none matches.

pub fn remove(&mut self, id: &str) -> Option<IssueHeading>

Remove the heading with id, if it is in this document.

Trait Implementations

impl Clone for IssueDoc

fn clone(&self) -> IssueDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IssueDoc

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

Formats the value using the given formatter.