summaryrefslogtreecommitdiffstats
path: root/lib/domain/libimagtodo/src/iter.rs
blob: 613799648d71eff9cf1dc3510ac9ed7a8891507f (plain)
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
//
// imag - the personal information management suite for the commandline
// Copyright (C) 2015-2019 Matthias Beyer <mail@beyermatthias.de> and contributors
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; version
// 2.1 of the License.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//

use std::result::Result as RResult;

use failure::Fallible as Result;
use failure::Error;
use filters::failable::filter::FailableFilter;

use libimagstore::store::FileLockEntry;
use libimagstore::store::Entry;

use crate::entry::Todo;
use crate::status::Status;
use crate::priority::Priority;

/// Iterator adaptor which filters an Iterator<Item = FileLockEntry> so that only todos are left
pub struct OnlyTodos<'a>(Box<dyn Iterator<Item = FileLockEntry<'a>>>);

impl<'a> OnlyTodos<'a> {
    pub fn new(it: Box<dyn Iterator<Item = FileLockEntry<'a>>>) -> Self {
        OnlyTodos(it)
    }
}

impl<'a> Iterator for OnlyTodos<'a> {
    type Item = Result<FileLockEntry<'a>>;

    fn next(&mut self) -> Option<Self::Item> {
        while let Some(next) = self.0.next() {
            match next.is_todo() {
                Ok(true)  => return Some(Ok(next)),
                Ok(false) => continue,
                Err(e)    => return Some(Err(e)),
            }
        }

        None
    }
}

/// Helper filter type
///
/// Can be used to filter an Iterator<Item = FileLockEntry> of Todos by status
///
pub struct StatusFilter(Status);

impl FailableFilter<Entry> for StatusFilter {
    type Error = Error;

    fn filter(&self, entry: &Entry) -> RResult<bool, Self::Error> {
        Ok(entry.get_status()? == self.0)
    }
}

/// Helper filter type
///
/// Can be used to filter an Iterator<Item = FileLockEntry> of Todos for scheduled todos
///
pub struct IsScheduledFilter;

impl FailableFilter<Entry> for IsScheduledFilter {
    type Error = Error;

    fn filter(&self, entry: &Entry) -> RResult<bool, Self::Error> {
        entry.get_scheduled().map(|s| s.is_some())
    }
}

/// Helper filter type
///
/// Can be used to filter an Iterator<Item = FileLockEntry> of Todos for hidden todos
///
pub struct IsHiddenFilter;

impl FailableFilter<Entry> for IsHiddenFilter {
    type Error = Error;

    fn filter(&self, entry: &Entry) -> RResult<bool, Self::Error> {
        entry.get_hidden().map(|s| s.is_some())
    }
}


/// Helper filter type
///
/// Can be used to filter an Iterator<Item = FileLockEntry> of Todos for due todos
///
pub struct IsDueFilter;

impl FailableFilter<Entry> for IsDueFilter {
    type Error = Error;

    fn filter(&self, entry: &Entry) -> RResult<bool, Self::Error> {
        entry.get_due().map(|s| s.is_some())
    }
}


/// Helper filter type
///
/// Can be used to filter an Iterator<Item = FileLockEntry> of Todos for priority
///
/// # Warning
///
/// If no priority is set for the entry, this filters out the entry
///
pub struct PriorityFilter(Priority);

impl FailableFilter<Entry> for PriorityFilter {
    type Error = Error;

    fn filter(&self, entry: &Entry) -> RResult<bool, Self::Error> {
        Ok(entry.get_priority()?.map(|p| p == self.0).unwrap_or(false))
    }
}