uxum 0.9.3

Opinionated backend service framework based on axum
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
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

//! Miscellaneous types used as request extensions.

use std::{
    borrow::{Borrow, BorrowMut},
    fmt,
    hash::Hash,
    ops::{Deref, DerefMut},
    time::{Duration, Instant},
};

use tokio::time::Instant as TokioInstant;

/// Static handler name.
///
/// This gets attached as an extension to requests and responses for use mainly in middleware
/// layers.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(transparent)]
pub struct HandlerName(&'static str);

impl HandlerName {
    /// Construct new [`HandlerName`] from static string slice.
    #[must_use]
    pub fn new(name: &'static str) -> Self {
        Self(name)
    }

    /// Get static string slice stored inside.
    #[must_use]
    pub fn as_str(&self) -> &'static str {
        self.0
    }
}

impl AsRef<str> for HandlerName {
    fn as_ref(&self) -> &str {
        self.0
    }
}

impl Deref for HandlerName {
    type Target = str;

    fn deref(&self) -> &Self::Target {
        self.0
    }
}

impl Borrow<str> for HandlerName {
    fn borrow(&self) -> &str {
        self.0
    }
}

impl fmt::Display for HandlerName {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.0)
    }
}

/// Cutoff time after which the request must be timed out.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(transparent)]
pub struct Deadline(Instant);

impl Deadline {
    /// Construct new [`Deadline`] with zero time left.
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    /// Check if deadline has passed.
    #[must_use]
    pub fn is_expired(&self) -> bool {
        self.0 >= Instant::now()
    }

    /// Get remaining time.
    ///
    /// Returns [`None`] if deadline has passed.
    #[must_use]
    pub fn time_left(&self) -> Option<Duration> {
        Instant::now().checked_duration_since(self.0)
    }
}

impl Default for Deadline {
    fn default() -> Self {
        Self(Instant::now())
    }
}

impl From<Duration> for Deadline {
    fn from(value: Duration) -> Self {
        Self(Instant::now() + value)
    }
}

impl From<Instant> for Deadline {
    fn from(value: Instant) -> Self {
        Self(value)
    }
}

impl From<TokioInstant> for Deadline {
    fn from(value: TokioInstant) -> Self {
        Self(value.into_std())
    }
}

impl AsRef<Instant> for Deadline {
    fn as_ref(&self) -> &Instant {
        &self.0
    }
}

impl Deref for Deadline {
    type Target = Instant;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl DerefMut for Deadline {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

impl Borrow<Instant> for Deadline {
    fn borrow(&self) -> &Instant {
        &self.0
    }
}

impl BorrowMut<Instant> for Deadline {
    fn borrow_mut(&mut self) -> &mut Instant {
        &mut self.0
    }
}

impl fmt::Display for Deadline {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "{}s left",
            self.time_left().unwrap_or_default().as_secs_f64()
        )
    }
}