humfmt 0.6.0

Ergonomic human-readable formatting toolkit for Rust
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276

//! Optional integration with [`time`](https://docs.rs/time).
//!
//! This module adapts `time::Duration` and `time::OffsetDateTime` values into
//! `humfmt` duration and relative-time formatters.
//!
//! # Feature flag
//!
//! Enable with:
//!
//! ```toml
//! humfmt = { version = "0.6", features = ["time"] }
//! ```
//!
//! # What this module provides
//!
//! - Convenience functions (`duration`, `ago`, `ago_since`, ...)
//! - Checked variants that return [`crate::DurationConversionError`]
//! - An extension trait [`TimeHumanize`] for ergonomic usage
//!
//! # Notes on negativity and range
//!
//! `core::time::Duration` cannot represent negative durations. Therefore:
//!
//! - Negative `time::Duration` values are rejected.
//! - The checked APIs return
//!   [`crate::DurationConversionError::NegativeDuration`] for negatives.
//!
//! # Examples
//!
//! ```rust
//! use humfmt::{time as humtime, DurationOptions};
//!
//! let delta = time::Duration::seconds(90);
//! assert_eq!(humtime::duration(delta).unwrap().to_string(), "1m 30s");
//!
//! let then = time::OffsetDateTime::from_unix_timestamp(0).unwrap();
//! let now = time::OffsetDateTime::from_unix_timestamp(3665).unwrap();
//! let out = humtime::ago_since_with(
//!     then,
//!     now,
//!     DurationOptions::new().long_units().max_units(3),
//! )
//! .unwrap();
//! assert_eq!(out.to_string(), "1 hour 1 minute 5 seconds ago");
//! ```

use crate::{
    ago::AgoDisplay, duration::DurationDisplay, DurationConversionError, DurationOptions,
    NegativeDurationError,
};

/// Extension methods for `time::Duration`.
///
/// This trait is intended for ergonomic usage:
///
/// ```rust
/// use humfmt::time::TimeHumanize;
///
/// let delta = time::Duration::seconds(90);
/// assert_eq!(delta.try_human_ago().unwrap().to_string(), "1m 30s ago");
/// ```
pub trait TimeHumanize: Sized {
    /// Formats this duration as a human-readable duration.
    ///
    /// Returns [`NegativeDurationError`] if the duration is negative.
    fn try_human_duration(self) -> Result<DurationDisplay, NegativeDurationError>;

    /// Formats this duration as a human-readable duration using custom options.
    ///
    /// Returns [`NegativeDurationError`] if the duration is negative.
    fn try_human_duration_with(
        self,
        options: DurationOptions,
    ) -> Result<DurationDisplay, NegativeDurationError>;

    /// Formats this duration as relative time (e.g. `"1m 30s ago"`).
    ///
    /// Returns [`NegativeDurationError`] if the duration is negative.
    fn try_human_ago(self) -> Result<AgoDisplay, NegativeDurationError>;

    /// Formats this duration as relative time using custom duration options.
    ///
    /// Returns [`NegativeDurationError`] if the duration is negative.
    fn try_human_ago_with(
        self,
        options: DurationOptions,
    ) -> Result<AgoDisplay, NegativeDurationError>;
}

impl TimeHumanize for ::time::Duration {
    #[inline]
    fn try_human_duration(self) -> Result<DurationDisplay, NegativeDurationError> {
        duration(self)
    }

    #[inline]
    fn try_human_duration_with(
        self,
        options: DurationOptions,
    ) -> Result<DurationDisplay, NegativeDurationError> {
        duration_with(self, options)
    }

    #[inline]
    fn try_human_ago(self) -> Result<AgoDisplay, NegativeDurationError> {
        ago(self)
    }

    #[inline]
    fn try_human_ago_with(
        self,
        options: DurationOptions,
    ) -> Result<AgoDisplay, NegativeDurationError> {
        ago_with(self, options)
    }
}

/// Formats a non-negative `time::Duration` with default duration options.
///
/// Returns [`NegativeDurationError`] if the duration is negative.
///
/// # Examples
///
/// ```rust
/// use humfmt::time as humtime;
///
/// let delta = time::Duration::seconds(90);
/// assert_eq!(humtime::duration(delta).unwrap().to_string(), "1m 30s");
/// ```
pub fn duration(value: ::time::Duration) -> Result<DurationDisplay, NegativeDurationError> {
    duration_with(value, DurationOptions::new())
}

/// Formats a non-negative `time::Duration` with custom duration options.
///
/// Returns [`NegativeDurationError`] if the duration is negative.
pub fn duration_with(
    value: ::time::Duration,
    options: DurationOptions,
) -> Result<DurationDisplay, NegativeDurationError> {
    duration_with_checked(value, options).map_err(|_| NegativeDurationError)
}

/// Formats a `time::Duration` with default duration options and explicit conversion errors.
///
/// This function distinguishes negative inputs via [`DurationConversionError`].
pub fn duration_checked(
    value: ::time::Duration,
) -> Result<DurationDisplay, DurationConversionError> {
    duration_with_checked(value, DurationOptions::new())
}

/// Formats a `time::Duration` with custom duration options and explicit conversion errors.
///
/// This function distinguishes negative inputs via [`DurationConversionError`].
pub fn duration_with_checked(
    value: ::time::Duration,
    options: DurationOptions,
) -> Result<DurationDisplay, DurationConversionError> {
    Ok(crate::duration::duration_with(
        to_std_checked(value)?,
        options,
    ))
}

/// Formats a non-negative `time::Duration` as relative time using default options.
///
/// Returns [`NegativeDurationError`] if the duration is negative.
///
/// # Examples
///
/// ```rust
/// use humfmt::time as humtime;
///
/// let delta = time::Duration::seconds(90);
/// assert_eq!(humtime::ago(delta).unwrap().to_string(), "1m 30s ago");
/// ```
pub fn ago(value: ::time::Duration) -> Result<AgoDisplay, NegativeDurationError> {
    ago_with(value, DurationOptions::new())
}

/// Formats a non-negative `time::Duration` as relative time with custom options.
///
/// Returns [`NegativeDurationError`] if the duration is negative.
pub fn ago_with(
    value: ::time::Duration,
    options: DurationOptions,
) -> Result<AgoDisplay, NegativeDurationError> {
    ago_with_checked(value, options).map_err(|_| NegativeDurationError)
}

/// Formats a `time::Duration` as relative time using default options and explicit conversion errors.
///
/// This function distinguishes negative inputs via [`DurationConversionError`].
pub fn ago_checked(value: ::time::Duration) -> Result<AgoDisplay, DurationConversionError> {
    ago_with_checked(value, DurationOptions::new())
}

/// Formats a `time::Duration` as relative time with custom options and explicit conversion errors.
///
/// This function distinguishes negative inputs via [`DurationConversionError`].
pub fn ago_with_checked(
    value: ::time::Duration,
    options: DurationOptions,
) -> Result<AgoDisplay, DurationConversionError> {
    Ok(crate::ago::ago_with(to_std_checked(value)?, options))
}

/// Formats the elapsed time between two `time::OffsetDateTime` values as relative time.
///
/// Returns [`NegativeDurationError`] if the elapsed duration is negative.
///
/// # Examples
///
/// ```rust
/// use humfmt::time as humtime;
///
/// let then = time::OffsetDateTime::from_unix_timestamp(0).unwrap();
/// let now = time::OffsetDateTime::from_unix_timestamp(90).unwrap();
/// assert_eq!(humtime::ago_since(then, now).unwrap().to_string(), "1m 30s ago");
/// ```
pub fn ago_since(
    then: ::time::OffsetDateTime,
    now: ::time::OffsetDateTime,
) -> Result<AgoDisplay, NegativeDurationError> {
    ago_checked(now - then).map_err(|_| NegativeDurationError)
}

/// Formats the elapsed time between two `time::OffsetDateTime` values as relative time
/// using custom options.
///
/// Returns [`NegativeDurationError`] if the elapsed duration is negative.
pub fn ago_since_with(
    then: ::time::OffsetDateTime,
    now: ::time::OffsetDateTime,
    options: DurationOptions,
) -> Result<AgoDisplay, NegativeDurationError> {
    ago_since_with_checked(then, now, options).map_err(|_| NegativeDurationError)
}

/// Formats the elapsed time between two `time::OffsetDateTime` values as relative time
/// with explicit conversion errors.
///
/// This function distinguishes negative inputs via [`DurationConversionError`].
pub fn ago_since_checked(
    then: ::time::OffsetDateTime,
    now: ::time::OffsetDateTime,
) -> Result<AgoDisplay, DurationConversionError> {
    ago_checked(now - then)
}

/// Formats the elapsed time between two `time::OffsetDateTime` values as relative time
/// with custom options and explicit conversion errors.
///
/// This function distinguishes negative inputs via [`DurationConversionError`].
pub fn ago_since_with_checked(
    then: ::time::OffsetDateTime,
    now: ::time::OffsetDateTime,
    options: DurationOptions,
) -> Result<AgoDisplay, DurationConversionError> {
    ago_with_checked(now - then, options)
}

/// Converts a `time::Duration` into `core::time::Duration`.
///
/// Returns [`DurationConversionError::NegativeDuration`] if `value` is negative,
/// since `core::time::Duration` cannot represent negative durations.
fn to_std_checked(
    value: ::time::Duration,
) -> Result<core::time::Duration, DurationConversionError> {
    if value.is_negative() {
        return Err(DurationConversionError::NegativeDuration);
    }

    Ok(value.unsigned_abs())
}