Struct IssueDoc 

pub struct IssueDoc {
    pub project: String,
    pub path: PathBuf,
    pub preamble: String,
    pub headings: Vec<IssueHeading>,
}

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

Fields

project: String

path: PathBuf

preamble: String

headings: Vec<IssueHeading>

Implementations

impl IssueDoc

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

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

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

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

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.

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

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

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

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.