src/annotation.rs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
//

//! Module containing types and functions for annotations of tasks

use crate::date::Date;

/// Annotation type for task annotations.
/// Each annotation in taskwarrior consists of a date and a description,
/// the date is named "entry", the description "description" in the JSON export.
#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, PartialEq)]
pub struct Annotation {
    entry: Date,
    description: String,
}

impl Annotation {
    /// Create a new Annotation object
    pub fn new(entry: Date, description: String) -> Annotation {
        Annotation { entry, description }
    }

    /// Get the entry date
    pub fn entry(&self) -> &Date {
        &self.entry
    }

    /// Get the entry date mutable
    pub fn entry_mut(&mut self) -> &mut Date {
        &mut self.entry
    }

    /// Get the description text
    pub fn description(&self) -> &String {
        &self.description
    }

    /// Get the description text mutable
    pub fn description_mut(&mut self) -> &mut String {
        &mut self.description
    }
}

#[cfg(test)]
mod test {}