Skip to main content

TaskItem

Struct TaskItem 

Source
pub struct TaskItem {
Show 17 fields pub content: String, pub is_completed: bool, pub position: SourcePosition, pub created_date: Option<NaiveDate>, pub scheduled_date: Option<NaiveDate>, pub start_date: Option<NaiveDate>, pub due_date: Option<NaiveDate>, pub done_date: Option<NaiveDate>, pub cancelled_date: Option<NaiveDate>, pub priority: TaskPriority, pub recurrence: Option<String>, pub on_completion: Option<String>, pub id: Option<String>, pub depends_on: Vec<String>, pub tags: Vec<String>, pub block_ref: Option<String>, pub metadata: HashMap<String, String>,
}
Expand description

A task item in vault content

Fields§

§content: String

Task description with trailing Obsidian Tasks metadata removed.

§is_completed: bool§position: SourcePosition§created_date: Option<NaiveDate>§scheduled_date: Option<NaiveDate>§start_date: Option<NaiveDate>§due_date: Option<NaiveDate>§done_date: Option<NaiveDate>§cancelled_date: Option<NaiveDate>§priority: TaskPriority§recurrence: Option<String>

Recurrence rule text, for example every weekday.

§on_completion: Option<String>

On-completion action, for example keep or delete.

§id: Option<String>

Tasks plugin dependency ID without the leading 🆔 marker.

§depends_on: Vec<String>

Tasks plugin dependency IDs from or [dependsOn:: ...].

§tags: Vec<String>

Inline task tags without the leading #.

§block_ref: Option<String>

Obsidian block reference without the leading ^.

§metadata: HashMap<String, String>

Dataview inline fields parsed from trailing task metadata.

Standard fields are also projected into the typed fields above; custom fields remain available here.

Implementations§

Source§

impl TaskItem

Source

pub fn from_parsed_metadata( parsed: ParsedTaskMetadata, is_completed: bool, position: SourcePosition, ) -> TaskItem

Build a TaskItem from parsed Obsidian Tasks metadata.

Trait Implementations§

Source§

impl Clone for TaskItem

Source§

fn clone(&self) -> TaskItem

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 TaskItem

Source§

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

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

impl<'de> Deserialize<'de> for TaskItem

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<TaskItem, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for TaskItem

Source§

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

Serialize this value into the given Serde serializer. Read more

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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> Same for T

Source§

type Output = T

Should always be Self
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.