devela 0.28.0

A development substrate of coherence.
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

// devela::phys::time::fmt
//
//! Defines [`Timecode`].
//
// IMPROVE:
// - secs_f64: make a version with fixed format, and another custom reducible.
// - nanos_u64: to not show leading zeros for seconds.
// - nanos_u64: not just clamp the seconds but all to 999?

use crate::{Cmp, Digits, Float, NoTime, StringU8, TimeSplit, TimeSplitHourNano, is, write_at};
#[cfg(feature = "alloc")]
use crate::{String, format};

#[doc = crate::_tags!(time)]
/// Timecode splitting and formatting.
#[doc = crate::_doc_meta!{location("phys/time")}]
///
/// # Examples
/// ```
/// # use devela::Timecode;
/// assert_eq!(Timecode::secs_f64(3661.5), "01:01:01.500");
/// assert_eq!(Timecode::nanos_u64(1_002_003_004), "001s 002ms 003µs 004ns");
/// ```
#[derive(Debug)]
#[doc = crate::_doc_meta!{location("phys/time")}]
pub struct Timecode;

impl Timecode {
    /* time splitting */

    /// Decomposes a number of `seconds` in `{ h, m, s, ms }`.
    ///
    /// The maximum decomposition for [`u64::MAX`] is
    /// `{ h: 5_124_095_576_030_431, .. }` (more than 584_942_417 millenia).
    // -> 64 bits
    #[must_use]
    pub const fn split_secs_f64(
        seconds: f64,
    ) -> TimeSplitHourNano<u32, u8, u8, u16, NoTime, NoTime> {
        let ms = (Float(seconds).fract().0 * 1000.) as u16;
        let mut ts = Float(seconds).trunc().0 as u64;
        let h = (ts / 3600) as u32;
        ts %= 3600;
        let m = (ts / 60) as u8;
        let s = (ts % 60) as u8;
        TimeSplit::new_hour_nano(h, m, s, ms, (), ())
    }

    /// Splits a number of `nanoseconds` in `{ s, ms, µs, ns }`.
    ///
    /// The maximum decomposition for [`u64::MAX`] is
    /// `{ s: 1_266_874_889, .. }` (more than 40 years).
    // -> 80 bits
    #[must_use]
    pub const fn split_nanos_u64(
        nanos: u64,
    ) -> TimeSplitHourNano<NoTime, NoTime, u32, u16, u16, u16> {
        let (us_tmp, ns) = (nanos / 1000, (nanos % 1000) as u16);
        let (ms_tmp, us) = (us_tmp / 1000, (us_tmp % 1000) as u16);
        let (s, ms) = ((ms_tmp / 1000) as u32, (ms_tmp % 1000) as u16);
        TimeSplit::new_hour_nano((), (), s, ms, us, ns)
    }

    /// Splits a number of `nanoseconds` in `{ s, ms, µs, ns }`.
    ///
    /// The maximum decomposition for [`u32::MAX`] is
    /// `{ ns: 295, µs: 967, ms: 294, s: 4 }` (more than 4 seconds).
    // -> 56 bits
    #[must_use]
    pub const fn split_nanos_u32(
        nanos: u32,
    ) -> TimeSplitHourNano<NoTime, NoTime, u8, u16, u16, u16> {
        let (us_tmp, ns) = (nanos / 1000, (nanos % 1000) as u16);
        let (ms_tmp, us) = (us_tmp / 1000, (us_tmp % 1000) as u16);
        let (s, ms) = ((ms_tmp / 1000) as u8, (ms_tmp % 1000) as u16);
        TimeSplit::new_hour_nano((), (), s, ms, us, ns)
    }

    /* strings */

    /// Writes the time code as `HH:MM:SS.mmm` or `MM:SS.mmm`.
    ///
    /// Hours are clamped to `99`.
    ///
    /// Returns the number of bytes written, or `0` if `buf` is too small.
    pub const fn write_secs_f64(buf: &mut [u8], seconds: f64) -> usize {
        let TimeSplitHourNano { h, m, s, ms, .. } = Self::split_secs_f64(seconds);
        let has_hours = h > 0;
        let len = is! { has_hours, 12, 9 };
        is! { buf.len() < len, return 0 }
        let mut pos = 0;
        if has_hours {
            pos += Self::write_2(buf, pos, Cmp(h).min(99) as u16);
            write_at![buf, +=pos, b':'];
        }
        pos += Self::write_2(buf, pos, m as u16);
        write_at![buf, +=pos, b':'];
        pos += Self::write_2(buf, pos, s as u16);
        write_at![buf, +=pos, b'.'];
        pos += Self::write_3(buf, pos, ms);
        pos
    }
    /// Returns the time code as `HH:MM:SS.mmm` or `MM:SS.mmm`.
    ///
    /// Hours are clamped to `99`.
    ///
    /// # Features
    /// Uses `unsafe_str` if enabled.
    pub const fn secs_f64(seconds: f64) -> StringU8<12> {
        let mut buf = [0; 12];
        let len = Self::write_secs_f64(&mut buf, seconds) as u8;
        cfg_select! { all(feature = "unsafe_str", not(feature = "safe_time")) => {
            // SAFETY: only valid UTF-8 bytes are written.
            unsafe { StringU8::<12>::from_array_nleft_unchecked(buf, len) }
        } _ => {
            crate::unwrap![ok StringU8::<12>::from_array_nleft(buf, len)]
        }}
    }

    /// Returns the time code, up to seconds, as `001s 012ms 012µs 012ns`.
    ///
    /// The seconds are clamped to 999 (more than 16 minutes).
    /// TODO TEST
    #[cfg(feature = "alloc")]
    #[cfg_attr(nightly_doc, doc(cfg(feature = "alloc")))]
    // -> 192 bits in "64", 92 bits in "32"
    pub fn nanos_u64_alloc(ns: u64) -> String {
        let (us, ns_rem) = (ns / 1_000, ns % 1_000);
        let (ms, us_rem) = (us / 1_000, us % 1_000);
        let (s, ms_rem) = (ms / 1_000, ms % 1_000);
        let s = s.min(999);

        if s > 0 {
            format!["{s}s {ms_rem:03}ms {us_rem:03}µs {ns_rem:03}ns"]
        } else if ms > 0 {
            format!["{ms_rem}ms {us_rem:03}µs {ns_rem:03}ns"]
        } else if us > 0 {
            format!["{us_rem}µs {ns_rem:03}ns"]
        } else {
            format!["{ns_rem:03}ns"]
        }
    }

    /// Writes a compact nanosecond time code.
    ///
    /// Format examples:
    /// - `001s 002ms 003µs 004ns`
    /// - `002ms 003µs 004ns`
    /// - `003µs 004ns`
    /// - `004ns`
    ///
    /// Seconds are clamped to `999`.
    ///
    /// Returns the number of bytes written, or `0` if `buf` is too small.
    pub const fn write_nanos_u64(buf: &mut [u8], nanos: u64) -> usize {
        let TimeSplitHourNano { s, ms, us, ns, .. } = Self::split_nanos_u64(nanos);
        let len = is![s > 0, 23, is![ms > 0, 18, is![us > 0, 12, 5]]];
        is![buf.len() < len, return 0];
        let mut pos = 0;
        if s > 0 {
            pos += Self::write_3(buf, pos, Cmp(s).min(999) as u16);
            write_at![buf, +=pos, b's', b' ']; // s
        }
        if s > 0 || ms > 0 {
            pos += Self::write_3(buf, pos, ms);
            write_at![buf, +=pos, b'm', b's', b' ']; // ms
        }
        if s > 0 || ms > 0 || us > 0 {
            pos += Self::write_3(buf, pos, us);
            write_at![buf, +=pos, 0xC2, 0xB5, b's', b' ']; // µs
        }
        pos += Self::write_3(buf, pos, ns);
        write_at![buf, +=pos, b'n', b's'];
        pos
    }
    /// Returns the time code, up to seconds, as `001s 002ms 003µs 004ns`.
    ///
    /// Seconds are clamped to `999`.
    ///
    /// # Features
    /// Uses `unsafe_str` if enabled.
    pub const fn nanos_u64(nanos: u64) -> StringU8<23> {
        let mut buf = [0; 23];
        let len = Self::write_nanos_u64(&mut buf, nanos) as u8;
        cfg_select! { all(feature = "unsafe_str", not(feature = "safe_time")) => {
            // SAFETY: only valid UTF-8 bytes are written.
            unsafe { StringU8::<23>::from_array_nleft_unchecked(buf, len) }
        } _ => {
            crate::unwrap![ok StringU8::<23>::from_array_nleft(buf, len)]
        }}
    }

    /* helpers */

    #[inline(always)]
    const fn write_2(buf: &mut [u8], pos: usize, n: u16) -> usize {
        let d = Digits(n).digits10_2();
        buf[pos] = d[0];
        buf[pos + 1] = d[1];
        2
    }
    #[inline(always)]
    const fn write_3(buf: &mut [u8], pos: usize, n: u16) -> usize {
        let d = Digits(n).digits10_3();
        buf[pos] = d[0];
        buf[pos + 1] = d[1];
        buf[pos + 2] = d[2];
        3
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn timecode_split_secs_f64() {
        let result = Timecode::split_secs_f64(3661.500);
        assert_eq!(8, size_of_val(&result)); //
        assert_eq!(result, TimeSplit::new_hour_nano(1, 1, 1, 500, (), ()));
    }
    #[test]
    fn timecode_split_nanos_u64() {
        let result = Timecode::split_nanos_u64(1_002_003_004);
        assert_eq!(12, size_of_val(&result));
        assert_eq!(result, TimeSplit::new_hour_nano((), (), 1, 2, 3, 4));
    }
    #[test]
    fn timecode_split_nanos_u32() {
        let result = Timecode::split_nanos_u32(1_002_003);
        assert_eq!(8, size_of_val(&result));
        assert_eq!(result, TimeSplit::new_hour_nano((), (), 0, 1, 2, 3));
    }
    #[test]
    fn timecode_secs_f64() {
        let formatted = Timecode::secs_f64(3661.5);
        assert_eq!(formatted, "01:01:01.500");
    }
    #[test]
    #[cfg(feature = "alloc")]
    fn timecode_nanos_u64_alloc() {
        let formatted = Timecode::nanos_u64_alloc(1_002_003_004);
        assert_eq!(formatted, "1s 002ms 003µs 004ns");
    }
    #[test]
    fn timecode_nanos_u64() {
        let formatted = Timecode::nanos_u64(1_002_003_004);
        assert_eq!(formatted, "001s 002ms 003µs 004ns");
    }
}