Struct Todo 

pub struct Todo { /* private fields */ }

VTODO (RFC 5545, Section 3.6.2 )

Implementations

impl Todo

pub fn new() -> Self

Creates a new Todo.

pub fn with_uid(uid: &str) -> Self

Creates a new Event with a UID.

pub fn done(&mut self) -> Self

End of builder pattern. copies over everything

pub fn percent_complete(&mut self, percent: u8) -> &mut Self

Set the PERCENT-COMPLETE property

Ranges between 0 - 100

pub fn remove_percent_complete(&mut self) -> &mut Self

Removes the PERCENT-COMPLETE property.

pub fn get_percent_complete(&self) -> Option<u8>

Gets the PERCENT-COMPLETE property.

Ranges between 0 - 100.

pub fn due<T: Into<DatePerhapsTime>>(&mut self, dt: T) -> &mut Self

Set the DUE property

See CalendarDateTime for info how are different chrono types converted automatically.

pub fn remove_due(&mut self) -> &mut Self

Removes the DUE property

pub fn get_due(&self) -> Option<DatePerhapsTime>

Gets the DUE property

pub fn completed(&mut self, dt: DateTime<Utc>) -> &mut Self

Set the COMPLETED property

Per RFC 5545, Section 3.8.2.1, this must be a date-time in UTC format.

pub fn remove_completed(&mut self) -> &mut Self

Removes the COMPLETED property

pub fn get_completed(&self) -> Option<DateTime<Utc>>

Gets the COMPLETED property

Per RFC 5545, Section 3.8.2.1, this must be a date-time in UTC format.

pub fn status(&mut self, status: TodoStatus) -> &mut Self

Defines the overall status or confirmation

pub fn remove_status(&mut self) -> &mut Self

Removes the overall status

pub fn get_status(&self) -> Option<TodoStatus>

Gets the overall status.

pub fn mark_uncompleted(&mut self) -> &mut Self

Mark a todo as uncompleted by removing completion-related properties.

This removes the following properties:

• COMPLETED: The timestamp when the task was completed
• PERCENT-COMPLETE: The percentage of the task that has been completed
• STATUS: The task status, if it was set to “COMPLETED”

Example

use icalendar::{Todo, Component, TodoStatus};
use chrono::Utc;

let mut todo = Todo::new()
    .completed(Utc::now())
    .percent_complete(100)
    .status(TodoStatus::Completed)
    .done();

// Later, when marking the task as uncompleted:
todo.mark_uncompleted();

Trait Implementations

impl Clone for Todo

fn clone(&self) -> Todo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for Todo

fn component_kind(&self) -> String

Tells you what kind of Component this is

Might be VEVENT, VTODO, VALARM etc

fn properties(&self) -> &BTreeMap<String, Property>

Read-only access to properties

fn components(&self) -> &[Other]

Read-only access to properties

fn multi_properties(&self) -> &BTreeMap<String, Vec<Property>>

Read-only access to multi_properties

fn append_property(&mut self, property: impl Into<Property>) -> &mut Self

Adds a Property

fn append_component(&mut self, child: impl Into<Other>) -> &mut Self

Appends a Component

fn append_multi_property(&mut self, property: impl Into<Property>) -> &mut Self

Adds a Property of which there may be many

fn remove_property(&mut self, key: &str) -> &mut Self

Removes a Property by its key if it exists

fn remove_multi_property(&mut self, key: &str) -> &mut Self

Removes a multi-property by its key if it exists

fn property_value(&self, key: &str) -> Option<&str>

Gets the value of a property.

fn fmt_write<W: Write>(&self, out: &mut W) -> Result<(), Error>

Writes Component using std::fmt.

fn to_string(&self) -> String

Serializes this component into rfc5545 again

fn try_into_string(&self) -> Result<String, Error>

Serializes this component into rfc5545 again

fn add_property( &mut self, key: impl Into<String>, val: impl Into<String>, ) -> &mut Self

Construct and append a Property

fn add_property_pre_alloc(&mut self, key: String, val: String) -> &mut Self

👎Deprecated

Construct and append a Property

fn add_multi_property(&mut self, key: &str, val: &str) -> &mut Self

Construct and append a Property

fn timestamp(&mut self, dt: DateTime<Utc>) -> &mut Self

Set the DTSTAMP Property

fn remove_timestamp(&mut self) -> &mut Self

Remove the DTSTAMP Property

fn get_timestamp(&self) -> Option<DateTime<Utc>>

Gets the DTSTAMP property.

fn get_start(&self) -> Option<DatePerhapsTime>

Gets the DTSTART Property

fn get_recurrence_id(&self) -> Option<DatePerhapsTime>

Gets the RECURRENCE-ID property.

fn get_end(&self) -> Option<DatePerhapsTime>

Gets the DTEND Property

fn priority(&mut self, priority: u32) -> &mut Self

Defines the relative priority.

fn remove_priority(&mut self) -> &mut Self

Removes the relative priority.

fn get_priority(&self) -> Option<u32>

Gets the relative priority.

fn print(&self) -> Result<(), Error>

Prints to stdout

fn summary(&mut self, desc: &str) -> &mut Self

Set the summary

fn remove_summary(&mut self) -> &mut Self

Removes the summary

fn get_summary(&self) -> Option<&str>

Gets the summary

fn description(&mut self, desc: &str) -> &mut Self

Set the description

fn remove_description(&mut self) -> &mut Self

Removes the description

fn get_description(&self) -> Option<&str>

Gets the description

fn uid(&mut self, uid: &str) -> &mut Self

Set the UID

fn get_uid(&self) -> Option<&str>

Gets the UID

fn sequence(&mut self, sequence: u32) -> &mut Self

Set the sequence

fn remove_sequence(&mut self) -> &mut Self

Removes the sequence

fn get_sequence(&self) -> Option<u32>

Gets the sequence

fn class(&mut self, class: Class) -> &mut Self

Set the visibility class

fn remove_class(&mut self) -> &mut Self

Removes the visibility class

fn get_class(&self) -> Option<Class>

Gets the visibility class

fn url(&mut self, url: &str) -> &mut Self

Sets the URL.

fn remove_url(&mut self) -> &mut Self

Removes the URL.

fn get_url(&self) -> Option<&str>

Gets the URL.

fn last_modified(&mut self, dt: DateTime<Utc>) -> &mut Self

Set the LAST-MODIFIED Property

fn remove_last_modified(&mut self) -> &mut Self

Removes the LAST-MODIFIED Property

fn get_last_modified(&self) -> Option<DateTime<Utc>>

Gets the LAST-MODIFIED property.

fn created(&mut self, dt: DateTime<Utc>) -> &mut Self

Set the CREATED Property

fn remove_created(&mut self) -> &mut Self

Removes the CREATED Property

fn get_created(&self) -> Option<DateTime<Utc>>

Gets the CREATED property.

impl Debug for Todo

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

Formats the value using the given formatter.

impl Default for Todo

fn default() -> Todo

Returns the “default value” for a type.

impl EventLike for Todo

fn starts<T: Into<DatePerhapsTime>>(&mut self, dt: T) -> &mut Self

Set the DTSTART Property

fn remove_starts(&mut self) -> &mut Self

removes the DTSTART Property

fn ends<T: Into<DatePerhapsTime>>(&mut self, dt: T) -> &mut Self

Set the DTEND Property

fn remove_ends(&mut self) -> &mut Self

Removes the DTEND Property

fn recurrence_id<T: Into<DatePerhapsTime>>(&mut self, dt: T) -> &mut Self

Sets the RECURRENCE-ID property.

fn remove_recurrence_id(&mut self) -> &mut Self

Removes the RECURRENCE-ID

fn all_day(&mut self, date: NaiveDate) -> &mut Self

Set the DTSTART Property and DTEND Property, date only

fn venue(&mut self, location: &str, venue_uid: &str) -> &mut Self

Set the LOCATION with a VVENUE UID iCalender venue draft

fn location(&mut self, location: &str) -> &mut Self

Set the LOCATION 3.8.1.7. Location

fn remove_location(&mut self) -> &mut Self

Removes the LOCATION with a VVENUE UID

fn get_location(&self) -> Option<&str>

Gets the location

fn alarm<A: Into<Alarm>>(&mut self, alarm: A) -> &mut Self

Set the ALARM for this event 3.6.6. Alarm Component

impl From<&Todo> for CalendarComponent

fn from(val: &Todo) -> Self

Converts to this type from the input type.

impl From<&mut Todo> for CalendarComponent

fn from(val: &mut Todo) -> Self

Converts to this type from the input type.

impl From<Todo> for CalendarComponent

fn from(val: Todo) -> Self

Converts to this type from the input type.

impl PartialEq for Todo

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryInto<String> for Todo

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<String, Self::Error>

Performs the conversion.

impl Eq for Todo

impl StructuralPartialEq for Todo