Skip to main content

IssueHeading

Struct IssueHeading 

Source
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 property_order: Vec<String>,
    pub body: String,
    pub logbook: Vec<LogEntry>,
    pub line_start: usize,
    pub line_end: usize,
}
Expand description

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

Fields§

§id: String§title: String§state: String§priority: char§properties: BTreeMap<String, String>§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.

§property_order: Vec<String>§body: String§logbook: Vec<LogEntry>§line_start: usize§line_end: usize

Implementations§

Source§

impl IssueHeading

Source

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

Ids listed in :BLOCKED_BY:. Commas and whitespace both separate, so values written by hand or by an importer parse the same way.

Source

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

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

Source

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

Source

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

Source

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

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

pub fn render(&self) -> String

Source

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§

Source§

impl Clone for IssueHeading

Source§

fn clone(&self) -> IssueHeading

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for IssueHeading

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for IssueHeading

Source§

impl PartialEq for IssueHeading

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for IssueHeading

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for IssueHeading

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.