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
use crate::{Buffer, FieldType};
const ERR_INVALID: &str = "Invalid time.";
const LEN_IN_BYTES_NO_MILLI: usize = 8;
const LEN_IN_BYTES_WITH_MILLI: usize = 12;
const MAX_HOUR: u32 = 23;
const MAX_MINUTE: u32 = 59;
const MAX_SECOND: u32 = 60; // Leap seconds.
const MAX_MILLISECOND: u32 = 999;
/// Canonical data field (DTF) for
/// [`FixDatatype::UtcTimeOnly`](crate::dict::FixDatatype::UtcTimeOnly).
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub struct Time {
hour: u32,
minute: u32,
second: u32,
milli: u32,
}
impl Time {
/// Creates a new time value from its components, with milliseconds.
pub fn from_hmsm(hour: u32, minute: u32, second: u32, milli: u32) -> Option<Self> {
if hour <= MAX_HOUR
&& minute <= MAX_MINUTE
&& second <= MAX_SECOND
&& milli <= MAX_MILLISECOND
{
Some(Self {
hour,
minute,
second,
milli,
})
} else {
None
}
}
/// Encodes `self` as a FIX field value in byte array.
pub const fn to_bytes(&self) -> [u8; LEN_IN_BYTES_WITH_MILLI] {
[
(self.hour() / 10) as u8 + b'0',
(self.hour() % 10) as u8 + b'0',
b':',
(self.minute() / 10) as u8 + b'0',
(self.minute() % 10) as u8 + b'0',
b':',
(self.second() / 10) as u8 + b'0',
(self.second() % 10) as u8 + b'0',
b'.',
(self.milli() / 100) as u8 + b'0',
((self.milli() / 10) % 10) as u8 % 10 + b'0',
(self.milli() % 10) as u8 + b'0',
]
}
/// Returns the hour of `self`.
///
/// # Examples
///
/// ```
/// use hotfix_encoding::field_access::FieldType;
/// use hotfix_encoding::field_types::Time;
///
/// let dtf = Time::deserialize(b"12:45:00").unwrap();
/// assert_eq!(dtf.hour(), 12)
/// ```
pub const fn hour(&self) -> u32 {
self.hour
}
/// Returns the hour of `self`.
///
/// # Examples
///
/// ```
/// use hotfix_encoding::field_access::FieldType;
/// use hotfix_encoding::field_types::Time;
///
/// let dtf = Time::deserialize(b"12:45:00").unwrap();
/// assert_eq!(dtf.minute(), 45)
/// ```
pub const fn minute(&self) -> u32 {
self.minute
}
/// Returns the second of `self`.
///
/// # Examples
///
/// ```
/// use hotfix_encoding::field_access::FieldType;
/// use hotfix_encoding::field_types::Time;
///
/// let dtf = Time::deserialize(b"12:45:00").unwrap();
/// assert_eq!(dtf.minute(), 45)
/// ```
///
/// Leap second:
///
/// ```
/// use hotfix_encoding::field_access::FieldType;
/// use hotfix_encoding::field_types::Time;
///
/// let dtf = Time::deserialize(b"23:59:60").unwrap();
/// assert_eq!(dtf.second(), 60)
/// ```
pub const fn second(&self) -> u32 {
self.second
}
/// Returns the milliecond of `self`.
///
/// # Examples
///
/// ```
/// use hotfix_encoding::field_access::FieldType;
/// use hotfix_encoding::field_types::Time;
///
/// let dtf = Time::deserialize(b"12:45:00.328").unwrap();
/// assert_eq!(dtf.milli(), 328)
/// ```
pub const fn milli(&self) -> u32 {
self.milli
}
/// Converts `self` to a [`chrono::NaiveTime`]. `chrono` might perform
/// additional checks, so this function might return `None` in case `self`
/// can't be directly converted to a [`chrono::NaiveTime`] instance.
#[cfg(feature = "utils-chrono")]
#[cfg_attr(doc_cfg, doc(cfg(feature = "utils-chrono")))]
pub fn to_chrono_naive(&self) -> Option<chrono::NaiveTime> {
chrono::NaiveTime::from_hms_milli_opt(
self.hour(),
self.minute(),
self.second(),
self.milli(),
)
}
}
impl<'a> FieldType<'a> for Time {
type Error = &'static str;
type SerializeSettings = ();
fn serialize_with<B>(&self, buffer: &mut B, _settings: ()) -> usize
where
B: Buffer,
{
let bytes = self.to_bytes();
buffer.extend_from_slice(&bytes[..]);
bytes.len()
}
fn deserialize(data: &'a [u8]) -> Result<Self, Self::Error> {
let mut milli = 0;
if data.len() == LEN_IN_BYTES_WITH_MILLI {
milli = ascii_digit_to_u32(data[9], 100)
+ ascii_digit_to_u32(data[10], 10)
+ ascii_digit_to_u32(data[11], 1);
if data[8] != b'.' {
return Err(ERR_INVALID);
}
} else if data.len() != LEN_IN_BYTES_NO_MILLI {
return Err(ERR_INVALID);
}
let digits_are_ok = data[2] == b':'
&& data[5] == b':'
&& is_ascii_digit(data[0])
&& is_ascii_digit(data[1])
&& is_ascii_digit(data[3])
&& is_ascii_digit(data[4])
&& is_ascii_digit(data[6])
&& is_ascii_digit(data[7]);
if !digits_are_ok {
return Err(ERR_INVALID);
}
let hour = ascii_digit_to_u32(data[0], 10) + ascii_digit_to_u32(data[1], 1);
let minute = ascii_digit_to_u32(data[3], 10) + ascii_digit_to_u32(data[4], 1);
let second = ascii_digit_to_u32(data[6], 10) + ascii_digit_to_u32(data[7], 1);
Self::from_hmsm(hour, minute, second, milli).ok_or(ERR_INVALID)
}
}
const fn is_ascii_digit(byte: u8) -> bool {
byte >= b'0' && byte <= b'9'
}
const fn ascii_digit_to_u32(digit: u8, multiplier: u32) -> u32 {
(digit as u32).wrapping_sub(b'0' as u32) * multiplier
}
#[cfg(test)]
mod test {
use super::*;
use quickcheck::{Arbitrary, Gen};
use quickcheck_macros::quickcheck;
impl Arbitrary for Time {
fn arbitrary(g: &mut Gen) -> Self {
let hour = u32::arbitrary(g) % 24;
let minute = u32::arbitrary(g) % 60;
let second = u32::arbitrary(g) % 60;
let millisecond = if bool::arbitrary(g) {
format!(".{:03}", u32::arbitrary(g) % 1000)
} else {
String::new()
};
let s = format!("{:02}:{:02}:{:02}{}", hour, minute, second, millisecond);
Self::deserialize(s.as_bytes()).unwrap()
}
}
struct TestCase {
bytes: &'static [u8],
hour: u32,
minute: u32,
second: u32,
milli: u32,
}
impl TestCase {
const fn new(
bytes: &'static [u8],
hour: u32,
minute: u32,
second: u32,
milli: u32,
) -> Self {
Self {
bytes,
hour,
minute,
second,
milli,
}
}
}
const VALID_TEST_CASES: &[TestCase] = &[
TestCase::new(b"00:00:00", 0, 0, 0, 0),
TestCase::new(b"00:00:00.123", 0, 0, 0, 123),
TestCase::new(b"12:00:00", 12, 0, 0, 0),
TestCase::new(b"23:59:60", 23, 59, 60, 0),
];
#[test]
fn valid_test_cases() {
for test_case in VALID_TEST_CASES {
let dtf = Time::deserialize(test_case.bytes).unwrap();
assert_eq!(dtf.hour(), test_case.hour);
assert_eq!(dtf.minute(), test_case.minute);
assert_eq!(dtf.second(), test_case.second);
assert_eq!(dtf.milli(), test_case.milli);
}
}
#[quickcheck]
fn verify_serialization_behavior(time: Time) -> bool {
crate::field_types::test_utility_verify_serialization_behavior(time)
}
}