Struct Task 

pub struct Task { /* private fields */ }

A to-do task

Implementations

impl Task

pub fn new(name: String, completed: bool, parent_calendar_url: &Url) -> Self

Create a brand new Task that is not on a server yet. This will pick a new (random) task ID.

Examples found in repository

examples/provider-sync.rs (line 58)

async fn add_items_and_sync_again(provider: &mut CalDavProvider) {
    println!("\nNow, we'll add a calendar and a few tasks and run the sync again.");
    pause();

    // Create a new calendar...
    let new_calendar_url: Url = EXAMPLE_CREATED_CALENDAR_URL.parse().unwrap();
    let new_calendar_name = "A brave new calendar".to_string();
    if let Err(_err) = provider.local_mut()
        .create_calendar(new_calendar_url.clone(), new_calendar_name.clone(), SupportedComponents::TODO, Some("#ff8000".parse().unwrap()))
        .await {
            println!("Unable to add calendar, maybe it exists already. We're not adding it after all.");
    }

    // ...and add a task in it
    let new_name = "This is a new task in a new calendar";
    let new_task = Task::new(String::from(new_name), true, &new_calendar_url);
    provider.local().get_calendar(&new_calendar_url).await.unwrap()
        .lock().unwrap().add_item(Item::Task(new_task)).await.unwrap();


    // Also create a task in a previously existing calendar
    let changed_calendar_url: Url = EXAMPLE_EXISTING_CALENDAR_URL.parse().unwrap();
    let new_task_name = "This is a new task we're adding as an example, with ÜTF-8 characters";
    let new_task = Task::new(String::from(new_task_name), false, &changed_calendar_url);
    let new_url = new_task.url().clone();
    provider.local().get_calendar(&changed_calendar_url).await.unwrap()
        .lock().unwrap().add_item(Item::Task(new_task)).await.unwrap();


    if provider.sync().await == false {
        log::warn!("Sync did not complete, see the previous log lines for more info. You can safely start a new sync. The new task may not have been synced.");
    } else {
        println!("Done syncing the new task '{}' and the new calendar '{}'", new_task_name, new_calendar_name);
    }
    provider.local().save_to_folder().unwrap();

    complete_item_and_sync_again(provider, &changed_calendar_url, &new_url).await;
}

pub fn new_with_parameters( name: String, uid: String, new_url: Url, completion_status: CompletionStatus, sync_status: SyncStatus, creation_date: Option<DateTime<Utc>>, last_modified: DateTime<Utc>, ical_prod_id: String, extra_parameters: Vec<Property>, ) -> Self

Create a new Task instance, that may be synced on the server already

pub fn url(&self) -> &Url

Examples found in repository

examples/provider-sync.rs (line 67)

async fn add_items_and_sync_again(provider: &mut CalDavProvider) {
    println!("\nNow, we'll add a calendar and a few tasks and run the sync again.");
    pause();

    // Create a new calendar...
    let new_calendar_url: Url = EXAMPLE_CREATED_CALENDAR_URL.parse().unwrap();
    let new_calendar_name = "A brave new calendar".to_string();
    if let Err(_err) = provider.local_mut()
        .create_calendar(new_calendar_url.clone(), new_calendar_name.clone(), SupportedComponents::TODO, Some("#ff8000".parse().unwrap()))
        .await {
            println!("Unable to add calendar, maybe it exists already. We're not adding it after all.");
    }

    // ...and add a task in it
    let new_name = "This is a new task in a new calendar";
    let new_task = Task::new(String::from(new_name), true, &new_calendar_url);
    provider.local().get_calendar(&new_calendar_url).await.unwrap()
        .lock().unwrap().add_item(Item::Task(new_task)).await.unwrap();


    // Also create a task in a previously existing calendar
    let changed_calendar_url: Url = EXAMPLE_EXISTING_CALENDAR_URL.parse().unwrap();
    let new_task_name = "This is a new task we're adding as an example, with ÜTF-8 characters";
    let new_task = Task::new(String::from(new_task_name), false, &changed_calendar_url);
    let new_url = new_task.url().clone();
    provider.local().get_calendar(&changed_calendar_url).await.unwrap()
        .lock().unwrap().add_item(Item::Task(new_task)).await.unwrap();


    if provider.sync().await == false {
        log::warn!("Sync did not complete, see the previous log lines for more info. You can safely start a new sync. The new task may not have been synced.");
    } else {
        println!("Done syncing the new task '{}' and the new calendar '{}'", new_task_name, new_calendar_name);
    }
    provider.local().save_to_folder().unwrap();

    complete_item_and_sync_again(provider, &changed_calendar_url, &new_url).await;
}

pub fn uid(&self) -> &str

pub fn name(&self) -> &str

pub fn completed(&self) -> bool

Examples found in repository

examples/toggle-completions.rs (line 44)

async fn toggle_all_tasks_and_sync_again(provider: &mut CalDavProvider) -> Result<(), Box<dyn Error>> {
    let mut n_toggled = 0;

    for (_url, cal) in provider.local().get_calendars_sync()?.iter() {
        for (_url, item) in cal.lock().unwrap().get_items_mut_sync()?.iter_mut() {
            match item {
                Item::Task(task) => {
                    match task.completed() {
                        false => task.set_completion_status(CompletionStatus::Completed(Some(Utc::now()))),
                        true => task.set_completion_status(CompletionStatus::Uncompleted),
                    };
                    n_toggled += 1;
                }
                Item::Event(_) => {
                    // Not doing anything with calendar events
                },
            }
        }
    }

    println!("{} items toggled.", n_toggled);
    println!("Syncing...");

    provider.sync().await;

    println!("Syncing complete.");

    Ok(())
}

pub fn ical_prod_id(&self) -> &str

pub fn sync_status(&self) -> &SyncStatus

pub fn last_modified(&self) -> &DateTime<Utc>

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

pub fn completion_status(&self) -> &CompletionStatus

pub fn extra_parameters(&self) -> &[Property]

pub fn set_sync_status(&mut self, new_status: SyncStatus)

pub fn set_name(&mut self, new_name: String)

Rename a task. This updates its “last modified” field

pub fn set_completion_status(&mut self, new_completion_status: CompletionStatus)

Set the completion status

Examples found in repository

examples/provider-sync.rs (line 94)

async fn complete_item_and_sync_again(
    provider: &mut CalDavProvider,
    changed_calendar_url: &Url,
    url_to_complete: &Url)
{
    println!("\nNow, we'll mark this last task as completed, and run the sync again.");
    pause();

    let completion_status = CompletionStatus::Completed(Some(Utc::now()));
    provider.local().get_calendar(changed_calendar_url).await.unwrap()
        .lock().unwrap().get_item_by_url_mut(url_to_complete).await.unwrap()
        .unwrap_task_mut()
        .set_completion_status(completion_status);

    if provider.sync().await == false {
        log::warn!("Sync did not complete, see the previous log lines for more info. You can safely start a new sync. The new task may not have been synced.");
    } else {
        println!("Done syncing the completed task");
    }
    provider.local().save_to_folder().unwrap();

    remove_items_and_sync_again(provider, changed_calendar_url, url_to_complete).await;
}

examples/toggle-completions.rs (line 45)

async fn toggle_all_tasks_and_sync_again(provider: &mut CalDavProvider) -> Result<(), Box<dyn Error>> {
    let mut n_toggled = 0;

    for (_url, cal) in provider.local().get_calendars_sync()?.iter() {
        for (_url, item) in cal.lock().unwrap().get_items_mut_sync()?.iter_mut() {
            match item {
                Item::Task(task) => {
                    match task.completed() {
                        false => task.set_completion_status(CompletionStatus::Completed(Some(Utc::now()))),
                        true => task.set_completion_status(CompletionStatus::Uncompleted),
                    };
                    n_toggled += 1;
                }
                Item::Event(_) => {
                    // Not doing anything with calendar events
                },
            }
        }
    }

    println!("{} items toggled.", n_toggled);
    println!("Syncing...");

    provider.sync().await;

    println!("Syncing complete.");

    Ok(())
}

Trait Implementations

impl Clone for Task

fn clone(&self) -> Task

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Task

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Task

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Task

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

where __S: Serializer,

Serialize this value into the given Serde serializer.