Struct IssueHeading 

pub struct IssueHeading {

    pub id: String,
    pub title: String,
    pub state: String,
    pub priority: char,
    pub properties: BTreeMap<String, String>,
    pub org_tags: Vec<String>,
    pub statistics: Option<String>,
    pub property_order: Vec<String>,
    pub extra_drawers: Vec<String>,
    pub body: String,
    pub logbook: Vec<LogEntry>,
    pub line_start: usize,
    pub line_end: usize,
}

One issue: a top-level org heading with a properties drawer, an optional logbook, and free-form body prose.

Fields

id: String

:ID: value, <project>-<suffix>.

title: String

Heading title, without a trailing tag run.

state: String

TODO keyword on the heading.

priority: char

Priority cookie character (A, B, or C).

properties: BTreeMap<String, String>

Property drawer, including planning keys held in the map.

org_tags: Vec<String>

Tags written on the heading itself, which is where Org’s own tag search and agenda look. Kept apart from the :TAGS: property so each round-trips as it was written; IssueHeading::tags reads both.

statistics: Option<String>

Trailing statistics cookies ([2/5], [40%]), which Org keeps on the headline after the title (manual 5.5).

property_order: Vec<String>

Drawer keys in on-disk order, so a rewrite leaves a hand-arranged drawer alone.

extra_drawers: Vec<String>

Drawers other than :PROPERTIES: and :LOGBOOK: that sat at the drawer site. Written back after those two so a rewrite does not drop a :NOTES: drawer someone put there.

body: String

Prose under the heading, without the property drawer or logbook.

logbook: Vec<LogEntry>

:LOGBOOK: lines, newest first.

line_start: usize

1-based first line of this heading in the file.

line_end: usize

1-based last line of this heading in the file.

Implementations

impl IssueHeading

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

Ids this heading waits on.

:BLOCKED_BY: is the vissue form. :BLOCKEDBY: is a typo for that. :BLOCKER: is GNU ELPA org-edna (and org-depend in org-contrib): an ids(...) form or a bare id list both count; prev-sibling and the rest of the condition language do not.

pub fn effort(&self) -> Option<&str>

Org Effort estimate (Effort or EFFORT), when set.

pub fn all_tags(&self, filetags: &[String]) -> Vec<String>

Own tags plus inherited FILETAGS (Org ALLTAGS for a top-level heading).

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

Every tag on the issue: the :VISSUE_TAGS: property and the heading’s own Org tags, in that order and without duplicates.

pub fn deadline(&self) -> Option<&str>

Deadline timestamp, when the heading carries one.

pub fn scheduled(&self) -> Option<&str>

Scheduled timestamp, when the heading carries one.

pub fn parent(&self) -> Option<&str>

:PARENT: id, when set.

pub fn claimed_by(&self) -> Option<&str>

The identity holding this issue, when one has claimed it.

pub fn claimed_at(&self) -> Option<&str>

When the claim was taken, as the stored org timestamp.

pub fn claim_age_days(&self, today: NaiveDate) -> Option<i64>

Whole days the claim has been held, when it parses as a date.

pub fn set_claim(&mut self, identity: &str)

Record the claim. Stores the identity verbatim: it is an opaque tag.

pub fn release_claim(&mut self) -> Option<(String, String)>

Drop the claim, leaving a logbook note so the history survives the properties being cleared.

pub fn render(&self) -> String

Heading, planning line, drawers, and body as they are written to disk.

pub fn record_state_change(&mut self, new_state: &str)

Move to new_state and prepend the transition to the logbook. A transition to the current state is not recorded.

Trait Implementations

impl Clone for IssueHeading

fn clone(&self) -> IssueHeading

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IssueHeading

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

Formats the value using the given formatter.

impl Eq for IssueHeading

impl PartialEq for IssueHeading

fn eq(&self, other: &IssueHeading) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for IssueHeading

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for IssueHeading