libimagentrydatetime 0.10.1

Library for the imag core distribution
Documentation 
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

//
// imag - the personal information management suite for the commandline
// Copyright (C) 2015-2020 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
//

/// The format which should be used to compile the datetime spec into a StoreId object.
///
/// # Warning
///
/// These settings depend on the Accuracy settings of the compiler as well.
///
/// If the compiler settings only specify an accuracy of `Accuracy::Month`, a setting of
/// `Format::ElementIsFolder` will result in the `month` beeing the file name.
///
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Debug)]
pub enum Format {
    /// Each element of the Path is one folder level.
    ///
    /// This is the default.
    ///
    /// # Example
    ///
    /// The date "1st May of 2017, 14:15:16" will be compiled to `2017/05/01/14/15/16`.
    ///
    /// The second is the filename, then.
    ///
    /// # Usecase
    ///
    /// When expecting a lot of entries, this makes sure that the tree is fast-traversible and has
    /// few files per folder (maximum 60).
    ///
    ElementIsFolder,

    /// Each element from Year to Day is folder, below is filename.
    ///
    /// # Example
    ///
    /// The date "1st May of 2017, 14:15:16" will be compiled to `2017/05/01/14-15-16`.
    ///
    /// # Usecase
    ///
    /// When expecting few entries per day.
    ///
    DaysAreFolder,

    /// Each element from Year to Month is folder, below is filename.
    ///
    /// # Example
    ///
    /// The date "1st May of 2017, 14:15:16" will be compiled to `2017/05/01T14-15-16`.
    ///
    /// # Usecase
    ///
    /// When expecting few entries per month.
    ///
    MonthIsFolder,

    /// Each element from Year to Month is folder, below is filename.
    ///
    /// # Example
    ///
    /// The date "1st May of 2017, 14:15:16" will be compiled to `2017/05-01T14-15-16`.
    ///
    /// # Usecase
    ///
    /// When expecting few entries per year.
    /// Might be never used.
    ///
    YearIsFolder,

}

impl Default for Format {
    fn default() -> Format {
        Format::ElementIsFolder
    }
}