timeflow 1.0.2

Ergonomic time handling (and traveling!) library with builder patterns, custom formatting, and seamless serialization for Date, Time, and DateTime operations
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

use chrono::Duration;
use serde::{Deserialize, Deserializer, Serialize, Serializer};

use crate::error::SpanError;

/// U is the Unit of the span
pub trait Span<U, F>
where
    Self: Sized,
{
    fn new(_: F, _: u32, _: u32) -> Result<Self, SpanError>;
    /// Getter for the format of the span
    fn get_format(&self) -> String;
    /// Setter for the format of the span
    fn format(self, format: impl ToString) -> Self;
    /// Reset the format of the span to the default format
    fn default_format(self) -> Self;
    /// Update the value of the span by a given Unit (U) and value.
    fn update(&self, unit: U, value: i32) -> Result<Self, SpanError>;
    /// Get the value of the span incremented by a given Unit (U).
    fn next(&self, unit: U) -> Result<Self, SpanError>;
    /// Return if the span matches the given unit and value.
    fn matches(&self, unit: U, value: u32) -> bool;
    /// Return the value of the span at system time.
    fn now() -> Result<Self, SpanError>;
    fn is_in_future(&self) -> Result<bool, SpanError>;
    fn elapsed(&self, lhs: &Self) -> Duration;
    fn unit_elapsed(&self, rhs: &Self, unit: U) -> Result<i64, SpanError>;
    fn clear_unit(&self, unit: U) -> Result<Self, SpanError>;
    fn deserialize_with_format<'de, D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
        Self: Deserialize<'de>;

    fn serialize_with_format<S: Serializer>(value: &Self, serializer: S) -> Result<S::Ok, S::Error>
    where
        Self: ToString,
    {
        #[derive(Serialize)]
        struct Visitor {
            date: String,
            format: String,
        }

        let visitor = Visitor {
            date: value.to_string(),
            format: value.get_format().clone(),
        };
        visitor.serialize(serializer)
    }
}