17 Commits

Author SHA1 Message Date
ea05a547ac Merge pull request 'add missing doc_cfg attr' (#67) from missing-doc-cfg-attr into main
All checks were successful
Rust/spacepackets/pipeline/head This commit looks good
Reviewed-on: #67
2024-03-04 12:58:28 +01:00
0ab69b3ddc add missing doc_cfg attr
Some checks are pending
Rust/spacepackets/pipeline/head Build started...
2024-03-04 12:55:16 +01:00
240f0bc267 Merge pull request 'CHANGELOG' (#66) from merge-conflict into main
All checks were successful
Rust/spacepackets/pipeline/head This commit looks good
Reviewed-on: #66
2024-03-04 12:52:49 +01:00
00744a22fc Merge branch 'main' of egit.irs.uni-stuttgart.de:rust/spacepackets
All checks were successful
Rust/spacepackets/pipeline/head This commit looks good
2024-03-04 12:26:29 +01:00
c5aeeec19f prepare rc.0 2024-03-04 12:25:47 +01:00
d13cd28962 Merge pull request 'add from impls' (#65) from ecss-enum-from-impls into main
All checks were successful
Rust/spacepackets/pipeline/head This commit looks good
Reviewed-on: #65
2024-03-04 12:20:01 +01:00
5641d9007e Merge remote-tracking branch 'origin/main' into ecss-enum-from-impls
All checks were successful
Rust/spacepackets/pipeline/head This commit looks good
Rust/spacepackets/pipeline/pr-main This commit looks good
2024-03-01 17:55:16 +01:00
f39ea2f793 Merge pull request 'improve the time API' (#64) from improve-time-api into main
All checks were successful
Rust/spacepackets/pipeline/head This commit looks good
Reviewed-on: #64
2024-03-01 17:54:31 +01:00
e4730d4b8f changelog
Some checks failed
Rust/spacepackets/pipeline/head This commit looks good
Rust/spacepackets/pipeline/pr-main There was a failure building this commit
2024-03-01 17:54:02 +01:00
64ea7e609d better naming
All checks were successful
Rust/spacepackets/pipeline/head This commit looks good
Rust/spacepackets/pipeline/pr-main This commit looks good
2024-03-01 17:52:51 +01:00
ebaa6210a4 add from impls
All checks were successful
Rust/spacepackets/pipeline/head This commit looks good
2024-03-01 17:51:16 +01:00
d14f532f62 improve the time API
All checks were successful
Rust/spacepackets/pipeline/head This commit looks good
Rust/spacepackets/pipeline/pr-main This commit looks good
2024-02-27 15:59:04 +01:00
6ea18d3715 Merge pull request 'added missing doc_cfg attribute' (#63) from add-missing-doc-cfg-attr into main
All checks were successful
Rust/spacepackets/pipeline/head This commit looks good
Reviewed-on: #63
2024-02-19 20:12:15 +01:00
6056342334 added missing doc_cfg attribute
All checks were successful
Rust/spacepackets/pipeline/head This commit looks good
2024-02-17 21:01:11 +01:00
4e6dcc5afa Merge pull request 'UnsignedEnum trait extensions' (#62) from unsigned-enum-vec-ext into main
All checks were successful
Rust/spacepackets/pipeline/head This commit looks good
Reviewed-on: #62
2024-02-17 13:41:51 +01:00
200593bfb4 added tests for vec converters
All checks were successful
Rust/spacepackets/pipeline/head This commit looks good
Rust/spacepackets/pipeline/pr-main This commit looks good
2024-02-17 13:27:28 +01:00
60bf876dd3 Extensions for UnsignedEnum trait
All checks were successful
Rust/spacepackets/pipeline/head This commit looks good
Rust/spacepackets/pipeline/pr-main This commit looks good
2024-02-17 13:24:25 +01:00
8 changed files with 241 additions and 85 deletions

View File

@@ -8,6 +8,27 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
# [unreleased] # [unreleased]
# [v0.11.0-rc.0] 2024-03-04
## Added
- `From<$TY>` for the `EcssEnum$TY` ECSS enum type definitions.
- `Sub` implementation for `UnixTimestamp` to calculate the duration between two timestamps.
## Changed
- `CcsdsTimeProvider` `subsecond_millis` function now returns `u16` instead of `Option<u16>`.
- `UnixTimestamp` `subsecond_millis` function now returns `u16` instead of `Option<u16>`.
# [v0.10.0] 2024-02-17
## Added
- Added `value` and `to_vec` methods for the `UnsignedEnum` trait. The value is returned as
as `u64`. Renamed former `value` method on `GenericUnsignedByteField` to `value_typed`.
- Added `value_const` const function for `UnsignedByteField` type.
- Added `value_typed` const functions for `GenericUnsignedByteField` and `GenericEcssEnumWrapper`.
# [v0.9.0] 2024-02-07 # [v0.9.0] 2024-02-07
## Added ## Added

View File

@@ -1,6 +1,6 @@
[package] [package]
name = "spacepackets" name = "spacepackets"
version = "0.9.0" version = "0.11.0-rc.0"
edition = "2021" edition = "2021"
rust-version = "1.61" rust-version = "1.61"
authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"] authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]

View File

@@ -581,7 +581,7 @@ mod tests {
assert_eq!(finished_pdu_vec.len(), 12); assert_eq!(finished_pdu_vec.len(), 12);
assert_eq!(finished_pdu_vec[9], TlvType::EntityId.into()); assert_eq!(finished_pdu_vec[9], TlvType::EntityId.into());
assert_eq!(finished_pdu_vec[10], 1); assert_eq!(finished_pdu_vec[10], 1);
assert_eq!(finished_pdu_vec[11], TEST_DEST_ID.value()); assert_eq!(finished_pdu_vec[11], TEST_DEST_ID.value_typed());
assert_eq!( assert_eq!(
finished_pdu.fault_location().unwrap().entity_id(), finished_pdu.fault_location().unwrap().entity_id(),
&TEST_DEST_ID.into() &TEST_DEST_ID.into()

View File

@@ -315,15 +315,19 @@ pub trait EcssEnumerationExt: EcssEnumeration + Debug + Copy + Clone + PartialEq
#[derive(Debug, Copy, Clone, Eq, PartialEq)] #[derive(Debug, Copy, Clone, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))] #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct GenericEcssEnumWrapper<TYPE: Copy> { pub struct GenericEcssEnumWrapper<TYPE: Copy + Into<u64>> {
field: GenericUnsignedByteField<TYPE>, field: GenericUnsignedByteField<TYPE>,
} }
impl<TYPE: Copy> GenericEcssEnumWrapper<TYPE> { impl<TYPE: Copy + Into<u64>> GenericEcssEnumWrapper<TYPE> {
pub const fn ptc() -> PacketTypeCodes { pub const fn ptc() -> PacketTypeCodes {
PacketTypeCodes::Enumerated PacketTypeCodes::Enumerated
} }
pub const fn value_typed(&self) -> TYPE {
self.field.value_typed()
}
pub fn new(val: TYPE) -> Self { pub fn new(val: TYPE) -> Self {
Self { Self {
field: GenericUnsignedByteField::new(val), field: GenericUnsignedByteField::new(val),
@@ -331,7 +335,7 @@ impl<TYPE: Copy> GenericEcssEnumWrapper<TYPE> {
} }
} }
impl<TYPE: Copy + ToBeBytes> UnsignedEnum for GenericEcssEnumWrapper<TYPE> { impl<TYPE: Copy + ToBeBytes + Into<u64>> UnsignedEnum for GenericEcssEnumWrapper<TYPE> {
fn size(&self) -> usize { fn size(&self) -> usize {
(self.pfc() / 8) as usize (self.pfc() / 8) as usize
} }
@@ -339,23 +343,45 @@ impl<TYPE: Copy + ToBeBytes> UnsignedEnum for GenericEcssEnumWrapper<TYPE> {
fn write_to_be_bytes(&self, buf: &mut [u8]) -> Result<usize, ByteConversionError> { fn write_to_be_bytes(&self, buf: &mut [u8]) -> Result<usize, ByteConversionError> {
self.field.write_to_be_bytes(buf) self.field.write_to_be_bytes(buf)
} }
fn value(&self) -> u64 {
self.field.value()
}
} }
impl<TYPE: Copy + ToBeBytes> EcssEnumeration for GenericEcssEnumWrapper<TYPE> { impl<TYPE: Copy + ToBeBytes + Into<u64>> EcssEnumeration for GenericEcssEnumWrapper<TYPE> {
fn pfc(&self) -> u8 { fn pfc(&self) -> u8 {
size_of::<TYPE>() as u8 * 8_u8 size_of::<TYPE>() as u8 * 8_u8
} }
} }
impl<TYPE: Debug + Copy + Clone + PartialEq + Eq + ToBeBytes> EcssEnumerationExt impl<TYPE: Debug + Copy + Clone + PartialEq + Eq + ToBeBytes + Into<u64>> EcssEnumerationExt
for GenericEcssEnumWrapper<TYPE> for GenericEcssEnumWrapper<TYPE>
{ {
} }
pub type EcssEnumU8 = GenericEcssEnumWrapper<u8>; macro_rules! generic_ecss_enum_typedefs_and_from_impls {
pub type EcssEnumU16 = GenericEcssEnumWrapper<u16>; ($($ty:ty => $Enum:ident),*) => {
pub type EcssEnumU32 = GenericEcssEnumWrapper<u32>; $(
pub type EcssEnumU64 = GenericEcssEnumWrapper<u64>; pub type $Enum = GenericEcssEnumWrapper<$ty>;
impl From<$ty> for $Enum {
fn from(value: $ty) -> Self {
Self::new(value)
}
}
)*
};
}
// Generates EcssEnum<$TY> type definitions as well as a From<$TY> for EcssEnum<$TY>
// implementation.
generic_ecss_enum_typedefs_and_from_impls! {
u8 => EcssEnumU8,
u16 => EcssEnumU16,
u32 => EcssEnumU32,
u64 => EcssEnumU64
}
/// Generic trait for PUS packet abstractions which can written to a raw slice as their raw /// Generic trait for PUS packet abstractions which can written to a raw slice as their raw
/// byte representation. This is especially useful for generic abstractions which depend only /// byte representation. This is especially useful for generic abstractions which depend only
@@ -396,6 +422,10 @@ mod tests {
.write_to_be_bytes(&mut buf[1..2]) .write_to_be_bytes(&mut buf[1..2])
.expect("To byte conversion of u8 failed"); .expect("To byte conversion of u8 failed");
assert_eq!(buf[1], 1); assert_eq!(buf[1], 1);
assert_eq!(my_enum.value(), 1);
assert_eq!(my_enum.value_typed(), 1);
let vec = my_enum.to_vec();
assert_eq!(vec, buf[1..2]);
} }
#[test] #[test]
@@ -409,6 +439,10 @@ mod tests {
assert_eq!(my_enum.pfc(), 16); assert_eq!(my_enum.pfc(), 16);
assert_eq!(buf[1], 0x1f); assert_eq!(buf[1], 0x1f);
assert_eq!(buf[2], 0x2f); assert_eq!(buf[2], 0x2f);
assert_eq!(my_enum.value(), 0x1f2f);
assert_eq!(my_enum.value_typed(), 0x1f2f);
let vec = my_enum.to_vec();
assert_eq!(vec, buf[1..3]);
} }
#[test] #[test]
@@ -440,6 +474,10 @@ mod tests {
assert_eq!(buf[2], 0x2f); assert_eq!(buf[2], 0x2f);
assert_eq!(buf[3], 0x3f); assert_eq!(buf[3], 0x3f);
assert_eq!(buf[4], 0x4f); assert_eq!(buf[4], 0x4f);
assert_eq!(my_enum.value(), 0x1f2f3f4f);
assert_eq!(my_enum.value_typed(), 0x1f2f3f4f);
let vec = my_enum.to_vec();
assert_eq!(vec, buf[1..5]);
} }
#[test] #[test]
@@ -460,6 +498,25 @@ mod tests {
} }
} }
#[test]
fn test_enum_u64() {
let mut buf = [0; 8];
let my_enum = EcssEnumU64::new(0x1f2f3f4f5f);
my_enum
.write_to_be_bytes(&mut buf)
.expect("To byte conversion of u64 failed");
assert_eq!(buf[3], 0x1f);
assert_eq!(buf[4], 0x2f);
assert_eq!(buf[5], 0x3f);
assert_eq!(buf[6], 0x4f);
assert_eq!(buf[7], 0x5f);
assert_eq!(my_enum.value(), 0x1f2f3f4f5f);
assert_eq!(my_enum.value_typed(), 0x1f2f3f4f5f);
assert_eq!(u64::from_be_bytes(buf), 0x1f2f3f4f5f);
let vec = my_enum.to_vec();
assert_eq!(vec, buf);
}
#[test] #[test]
fn test_pus_error_display() { fn test_pus_error_display() {
let unsupport_version = PusError::VersionNotSupported(super::PusVersion::EsaPus); let unsupport_version = PusError::VersionNotSupported(super::PusVersion::EsaPus);

View File

@@ -672,10 +672,8 @@ impl<ProvidesDaysLen: ProvidesDaysLength> TimeProvider<ProvidesDaysLen> {
unix_stamp: &UnixTimestamp, unix_stamp: &UnixTimestamp,
days_len: LengthOfDaySegment, days_len: LengthOfDaySegment,
) -> Result<Self, TimestampError> { ) -> Result<Self, TimestampError> {
let conv_from_dt = ConversionFromUnix::new( let conv_from_dt =
unix_stamp.unix_seconds, ConversionFromUnix::new(unix_stamp.unix_seconds, unix_stamp.subsecond_millis as u32)?;
unix_stamp.subsecond_millis.unwrap_or(0) as u32,
)?;
Self::generic_from_conversion(days_len, conv_from_dt) Self::generic_from_conversion(days_len, conv_from_dt)
} }
@@ -1148,7 +1146,7 @@ impl<ProvidesDaysLen: ProvidesDaysLength> CcsdsTimeProvider for TimeProvider<Pro
self.unix_stamp.unix_seconds self.unix_stamp.unix_seconds
} }
#[inline] #[inline]
fn subsecond_millis(&self) -> Option<u16> { fn subsecond_millis(&self) -> u16 {
self.unix_stamp.subsecond_millis self.unix_stamp.subsecond_millis
} }
@@ -1320,12 +1318,12 @@ mod tests {
(DAYS_CCSDS_TO_UNIX * SECONDS_PER_DAY as i32) as i64 (DAYS_CCSDS_TO_UNIX * SECONDS_PER_DAY as i32) as i64
); );
let subsecond_millis = unix_stamp.subsecond_millis; let subsecond_millis = unix_stamp.subsecond_millis;
assert!(subsecond_millis.is_none()); assert_eq!(subsecond_millis, 0);
assert_eq!( assert_eq!(
time_stamper.submillis_precision(), time_stamper.submillis_precision(),
SubmillisPrecision::Absent SubmillisPrecision::Absent
); );
assert!(time_stamper.subsecond_millis().is_none()); assert_eq!(time_stamper.subsecond_millis(), 0);
assert_eq!(time_stamper.ccdsd_time_code(), CcsdsTimeCodes::Cds); assert_eq!(time_stamper.ccdsd_time_code(), CcsdsTimeCodes::Cds);
assert_eq!( assert_eq!(
time_stamper.p_field(), time_stamper.p_field(),
@@ -1356,11 +1354,9 @@ mod tests {
assert_eq!(date_time.minute(), 0); assert_eq!(date_time.minute(), 0);
assert_eq!(date_time.second(), 0); assert_eq!(date_time.second(), 0);
let time_stamper = TimeProvider::new_with_u16_days((-DAYS_CCSDS_TO_UNIX) as u16, 40); let time_stamper = TimeProvider::new_with_u16_days((-DAYS_CCSDS_TO_UNIX) as u16, 40);
assert!(time_stamper.subsecond_millis().is_some()); assert_eq!(time_stamper.subsecond_millis(), 40);
assert_eq!(time_stamper.subsecond_millis().unwrap(), 40);
let time_stamper = TimeProvider::new_with_u16_days((-DAYS_CCSDS_TO_UNIX) as u16, 1040); let time_stamper = TimeProvider::new_with_u16_days((-DAYS_CCSDS_TO_UNIX) as u16, 1040);
assert!(time_stamper.subsecond_millis().is_some()); assert_eq!(time_stamper.subsecond_millis(), 40);
assert_eq!(time_stamper.subsecond_millis().unwrap(), 40);
} }
#[test] #[test]

View File

@@ -297,10 +297,10 @@ impl TimeProviderCcsdsEpoch {
unix_stamp.as_date_time().unwrap(), unix_stamp.as_date_time().unwrap(),
)); ));
} }
let mut fractions = None; let fractions = fractional_part_from_subsec_ns(
if let Some(subsec_millis) = unix_stamp.subsecond_millis { res,
fractions = fractional_part_from_subsec_ns(res, subsec_millis as u64 * 10_u64.pow(6)); unix_stamp.subsecond_millis() as u64 * 10_u64.pow(6),
} );
Self::new_generic(WidthCounterPair(4, ccsds_epoch as u32), fractions).map_err(|e| e.into()) Self::new_generic(WidthCounterPair(4, ccsds_epoch as u32), fractions).map_err(|e| e.into())
} }
@@ -610,15 +610,15 @@ impl CcsdsTimeProvider for TimeProviderCcsdsEpoch {
self.unix_seconds() self.unix_seconds()
} }
fn subsecond_millis(&self) -> Option<u16> { fn subsecond_millis(&self) -> u16 {
if let Some(fractions) = self.fractions { if let Some(fractions) = self.fractions {
if fractions.0 == FractionalResolution::Seconds { if fractions.0 == FractionalResolution::Seconds {
return None; return 0;
} }
// Rounding down here is the correct approach. // Rounding down here is the correct approach.
return Some((convert_fractional_part_to_ns(fractions) / 10_u32.pow(6) as u64) as u16); return (convert_fractional_part_to_ns(fractions) / 10_u32.pow(6) as u64) as u16;
} }
None 0
} }
fn date_time(&self) -> Option<DateTime<Utc>> { fn date_time(&self) -> Option<DateTime<Utc>> {
@@ -763,7 +763,7 @@ mod tests {
let zero_cuc = zero_cuc.unwrap(); let zero_cuc = zero_cuc.unwrap();
let res = zero_cuc.write_to_bytes(&mut buf); let res = zero_cuc.write_to_bytes(&mut buf);
assert!(res.is_ok()); assert!(res.is_ok());
assert!(zero_cuc.subsecond_millis().is_none()); assert_eq!(zero_cuc.subsecond_millis(), 0);
assert_eq!(zero_cuc.len_as_bytes(), 5); assert_eq!(zero_cuc.len_as_bytes(), 5);
assert_eq!(pfield_len(buf[0]), 1); assert_eq!(pfield_len(buf[0]), 1);
let written = res.unwrap(); let written = res.unwrap();
@@ -1130,7 +1130,7 @@ mod tests {
// What I would roughly expect // What I would roughly expect
assert_eq!(cuc_stamp2.counter.1, 203); assert_eq!(cuc_stamp2.counter.1, 203);
assert!(cuc_stamp2.fractions.unwrap().1 < 100); assert!(cuc_stamp2.fractions.unwrap().1 < 100);
assert!(cuc_stamp2.subsecond_millis().unwrap() <= 1); assert!(cuc_stamp2.subsecond_millis() <= 1);
} }
#[test] #[test]

View File

@@ -3,7 +3,7 @@ use crate::ByteConversionError;
use chrono::{DateTime, LocalResult, TimeZone, Utc}; use chrono::{DateTime, LocalResult, TimeZone, Utc};
use core::cmp::Ordering; use core::cmp::Ordering;
use core::fmt::{Display, Formatter}; use core::fmt::{Display, Formatter};
use core::ops::{Add, AddAssign}; use core::ops::{Add, AddAssign, Sub};
use core::time::Duration; use core::time::Duration;
use core::u8; use core::u8;
@@ -196,6 +196,7 @@ pub trait TimeWriter {
fn write_to_bytes(&self, bytes: &mut [u8]) -> Result<usize, TimestampError>; fn write_to_bytes(&self, bytes: &mut [u8]) -> Result<usize, TimestampError>;
#[cfg(feature = "alloc")] #[cfg(feature = "alloc")]
#[cfg_attr(doc_cfg, doc(cfg(feature = "alloc")))]
fn to_vec(&self) -> Result<alloc::vec::Vec<u8>, TimestampError> { fn to_vec(&self) -> Result<alloc::vec::Vec<u8>, TimestampError> {
let mut vec = alloc::vec![0; self.len_written()]; let mut vec = alloc::vec![0; self.len_written()];
self.write_to_bytes(&mut vec)?; self.write_to_bytes(&mut vec)?;
@@ -224,12 +225,9 @@ pub trait CcsdsTimeProvider {
fn ccdsd_time_code(&self) -> CcsdsTimeCodes; fn ccdsd_time_code(&self) -> CcsdsTimeCodes;
fn unix_seconds(&self) -> i64; fn unix_seconds(&self) -> i64;
fn subsecond_millis(&self) -> Option<u16>; fn subsecond_millis(&self) -> u16;
fn unix_stamp(&self) -> UnixTimestamp { fn unix_stamp(&self) -> UnixTimestamp {
if self.subsecond_millis().is_none() { UnixTimestamp::const_new(self.unix_seconds(), self.subsecond_millis())
return UnixTimestamp::new_only_seconds(self.unix_seconds());
}
UnixTimestamp::const_new(self.unix_seconds(), self.subsecond_millis().unwrap())
} }
fn date_time(&self) -> Option<DateTime<Utc>>; fn date_time(&self) -> Option<DateTime<Utc>>;
@@ -237,18 +235,16 @@ pub trait CcsdsTimeProvider {
/// UNIX timestamp: Elapsed seconds since 1970-01-01T00:00:00+00:00. /// UNIX timestamp: Elapsed seconds since 1970-01-01T00:00:00+00:00.
/// ///
/// Also can optionally include subsecond millisecond for greater accuracy. Please note that a /// Also can optionally include subsecond millisecond for greater accuracy.
/// subsecond millisecond value of 0 gets converted to [None].
#[derive(Default, Debug, Copy, Clone, PartialEq, Eq)] #[derive(Default, Debug, Copy, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))] #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct UnixTimestamp { pub struct UnixTimestamp {
pub unix_seconds: i64, pub unix_seconds: i64,
subsecond_millis: Option<u16>, subsecond_millis: u16,
} }
impl UnixTimestamp { impl UnixTimestamp {
/// Returns none if the subsecond millisecond value is larger than 999. 0 is converted to /// Returns [None] if the subsecond millisecond value is larger than 999.
/// a [None] value.
pub fn new(unix_seconds: i64, subsec_millis: u16) -> Option<Self> { pub fn new(unix_seconds: i64, subsec_millis: u16) -> Option<Self> {
if subsec_millis > 999 { if subsec_millis > 999 {
return None; return None;
@@ -257,15 +253,10 @@ impl UnixTimestamp {
} }
/// Like [Self::new] but const. Panics if the subsecond value is larger than 999. /// Like [Self::new] but const. Panics if the subsecond value is larger than 999.
pub const fn const_new(unix_seconds: i64, subsec_millis: u16) -> Self { pub const fn const_new(unix_seconds: i64, subsecond_millis: u16) -> Self {
if subsec_millis > 999 { if subsecond_millis > 999 {
panic!("subsec milliseconds exceeds 999"); panic!("subsec milliseconds exceeds 999");
} }
let subsecond_millis = if subsec_millis == 0 {
None
} else {
Some(subsec_millis)
};
Self { Self {
unix_seconds, unix_seconds,
subsecond_millis, subsecond_millis,
@@ -275,11 +266,11 @@ impl UnixTimestamp {
pub fn new_only_seconds(unix_seconds: i64) -> Self { pub fn new_only_seconds(unix_seconds: i64) -> Self {
Self { Self {
unix_seconds, unix_seconds,
subsecond_millis: None, subsecond_millis: 0,
} }
} }
pub fn subsecond_millis(&self) -> Option<u16> { pub fn subsecond_millis(&self) -> u16 {
self.subsecond_millis self.subsecond_millis
} }
@@ -293,19 +284,28 @@ impl UnixTimestamp {
#[inline] #[inline]
pub fn unix_seconds_f64(&self) -> f64 { pub fn unix_seconds_f64(&self) -> f64 {
let mut secs = self.unix_seconds as f64; self.unix_seconds as f64 + (self.subsecond_millis as f64 / 1000.0)
if let Some(subsec_millis) = self.subsecond_millis {
secs += subsec_millis as f64 / 1000.0;
}
secs
} }
pub fn as_date_time(&self) -> LocalResult<DateTime<Utc>> { pub fn as_date_time(&self) -> LocalResult<DateTime<Utc>> {
Utc.timestamp_opt( Utc.timestamp_opt(
self.unix_seconds, self.unix_seconds,
self.subsecond_millis.unwrap_or(0) as u32 * 10_u32.pow(6), self.subsecond_millis as u32 * 10_u32.pow(6),
) )
} }
// Calculate the difference in milliseconds between two UnixTimestamps
pub fn difference_in_millis(&self, other: &UnixTimestamp) -> i64 {
let seconds_difference = self.unix_seconds - other.unix_seconds;
// Convert seconds difference to milliseconds
let milliseconds_difference = seconds_difference * 1000;
// Calculate the difference in subsecond milliseconds directly
let subsecond_difference = self.subsecond_millis as i64 - other.subsecond_millis as i64;
// Combine the differences
milliseconds_difference + subsecond_difference
}
} }
impl From<DateTime<Utc>> for UnixTimestamp { impl From<DateTime<Utc>> for UnixTimestamp {
@@ -331,11 +331,7 @@ impl Ord for UnixTimestamp {
_ => (), _ => (),
} }
match self match self.subsecond_millis().cmp(&other.subsecond_millis()) {
.subsecond_millis()
.unwrap_or(0)
.cmp(&other.subsecond_millis().unwrap_or(0))
{
Ordering::Less => { Ordering::Less => {
return if self.unix_seconds < 0 { return if self.unix_seconds < 0 {
Ordering::Greater Ordering::Greater
@@ -356,12 +352,38 @@ impl Ord for UnixTimestamp {
} }
} }
/// Difference between two UNIX timestamps. The [Duration] type can not contain negative durations,
/// so the sign information is supplied separately.
#[derive(Clone, Copy, PartialEq, Eq)]
pub struct StampDiff {
pub positive_duration: bool,
pub duration_absolute: Duration,
}
impl Sub for UnixTimestamp {
type Output = StampDiff;
fn sub(self, rhs: Self) -> Self::Output {
let difference = self.difference_in_millis(&rhs);
if difference < 0 {
StampDiff {
positive_duration: false,
duration_absolute: Duration::from_millis(-difference as u64),
}
} else {
StampDiff {
positive_duration: true,
duration_absolute: Duration::from_millis(difference as u64),
}
}
}
}
fn get_new_stamp_after_addition( fn get_new_stamp_after_addition(
current_stamp: &UnixTimestamp, current_stamp: &UnixTimestamp,
duration: Duration, duration: Duration,
) -> UnixTimestamp { ) -> UnixTimestamp {
let mut new_subsec_millis = let mut new_subsec_millis = current_stamp.subsecond_millis() + duration.subsec_millis() as u16;
current_stamp.subsecond_millis().unwrap_or(0) + duration.subsec_millis() as u16;
let mut new_unix_seconds = current_stamp.unix_seconds; let mut new_unix_seconds = current_stamp.unix_seconds;
let mut increment_seconds = |value: u32| { let mut increment_seconds = |value: u32| {
if new_unix_seconds < 0 { if new_unix_seconds < 0 {
@@ -464,18 +486,17 @@ mod tests {
fn basic_unix_stamp_test() { fn basic_unix_stamp_test() {
let stamp = UnixTimestamp::new_only_seconds(-200); let stamp = UnixTimestamp::new_only_seconds(-200);
assert_eq!(stamp.unix_seconds, -200); assert_eq!(stamp.unix_seconds, -200);
assert!(stamp.subsecond_millis().is_none()); assert_eq!(stamp.subsecond_millis(), 0);
let stamp = UnixTimestamp::new_only_seconds(250); let stamp = UnixTimestamp::new_only_seconds(250);
assert_eq!(stamp.unix_seconds, 250); assert_eq!(stamp.unix_seconds, 250);
assert!(stamp.subsecond_millis().is_none()); assert_eq!(stamp.subsecond_millis(), 0);
} }
#[test] #[test]
fn basic_float_unix_stamp_test() { fn basic_float_unix_stamp_test() {
let stamp = UnixTimestamp::new(500, 600).unwrap(); let stamp = UnixTimestamp::new(500, 600).unwrap();
assert!(stamp.subsecond_millis.is_some());
assert_eq!(stamp.unix_seconds, 500); assert_eq!(stamp.unix_seconds, 500);
let subsec_millis = stamp.subsecond_millis().unwrap(); let subsec_millis = stamp.subsecond_millis();
assert_eq!(subsec_millis, 600); assert_eq!(subsec_millis, 600);
assert!((500.6 - stamp.unix_seconds_f64()).abs() < 0.0001); assert!((500.6 - stamp.unix_seconds_f64()).abs() < 0.0001);
} }
@@ -524,6 +545,7 @@ mod tests {
assert!(stamp2 <= stamp1); assert!(stamp2 <= stamp1);
} }
#[allow(clippy::nonminimal_bool)]
#[test] #[test]
fn test_eq() { fn test_eq() {
let stamp0 = UnixTimestamp::new(5, 0).unwrap(); let stamp0 = UnixTimestamp::new(5, 0).unwrap();
@@ -540,11 +562,10 @@ mod tests {
let mut stamp0 = UnixTimestamp::new_only_seconds(1); let mut stamp0 = UnixTimestamp::new_only_seconds(1);
stamp0 += Duration::from_secs(5); stamp0 += Duration::from_secs(5);
assert_eq!(stamp0.unix_seconds, 6); assert_eq!(stamp0.unix_seconds, 6);
assert!(stamp0.subsecond_millis().is_none()); assert_eq!(stamp0.subsecond_millis(), 0);
let stamp1 = stamp0 + Duration::from_millis(500); let stamp1 = stamp0 + Duration::from_millis(500);
assert_eq!(stamp1.unix_seconds, 6); assert_eq!(stamp1.unix_seconds, 6);
assert!(stamp1.subsecond_millis().is_some()); assert_eq!(stamp1.subsecond_millis(), 500);
assert_eq!(stamp1.subsecond_millis().unwrap(), 500);
} }
#[test] #[test]
@@ -552,7 +573,7 @@ mod tests {
let stamp0 = &UnixTimestamp::new(20, 500).unwrap(); let stamp0 = &UnixTimestamp::new(20, 500).unwrap();
let stamp1 = stamp0 + Duration::from_millis(2500); let stamp1 = stamp0 + Duration::from_millis(2500);
assert_eq!(stamp1.unix_seconds, 23); assert_eq!(stamp1.unix_seconds, 23);
assert!(stamp1.subsecond_millis().is_none()); assert_eq!(stamp1.subsecond_millis(), 0);
} }
#[test] #[test]
@@ -574,15 +595,50 @@ mod tests {
assert!(dt_now.year() >= 2020); assert!(dt_now.year() >= 2020);
} }
#[test]
fn test_stamp_diff_positive_0() {
let stamp_later = UnixTimestamp::new(2, 0).unwrap();
let StampDiff {
positive_duration,
duration_absolute,
} = stamp_later - UnixTimestamp::new(1, 0).unwrap();
assert!(positive_duration);
assert_eq!(duration_absolute, Duration::from_secs(1));
}
#[test]
fn test_stamp_diff_positive_1() {
let stamp_later = UnixTimestamp::new(3, 800).unwrap();
let stamp_earlier = UnixTimestamp::new(1, 900).unwrap();
let StampDiff {
positive_duration,
duration_absolute,
} = stamp_later - stamp_earlier;
assert!(positive_duration);
assert_eq!(duration_absolute, Duration::from_millis(1900));
}
#[test]
fn test_stamp_diff_negative() {
let stamp_later = UnixTimestamp::new(3, 800).unwrap();
let stamp_earlier = UnixTimestamp::new(1, 900).unwrap();
let StampDiff {
positive_duration,
duration_absolute,
} = stamp_earlier - stamp_later;
assert!(!positive_duration);
assert_eq!(duration_absolute, Duration::from_millis(1900));
}
#[test] #[test]
fn test_addition_spillover() { fn test_addition_spillover() {
let mut stamp0 = UnixTimestamp::new(1, 900).unwrap(); let mut stamp0 = UnixTimestamp::new(1, 900).unwrap();
stamp0 += Duration::from_millis(100); stamp0 += Duration::from_millis(100);
assert_eq!(stamp0.unix_seconds, 2); assert_eq!(stamp0.unix_seconds, 2);
assert!(stamp0.subsecond_millis().is_none()); assert_eq!(stamp0.subsecond_millis(), 0);
stamp0 += Duration::from_millis(1100); stamp0 += Duration::from_millis(1100);
assert_eq!(stamp0.unix_seconds, 3); assert_eq!(stamp0.unix_seconds, 3);
assert_eq!(stamp0.subsecond_millis().unwrap(), 100); assert_eq!(stamp0.subsecond_millis(), 100);
} }
#[test] #[test]

View File

@@ -73,6 +73,16 @@ pub trait UnsignedEnum {
fn size(&self) -> usize; fn size(&self) -> usize;
/// Write the unsigned enumeration to a raw buffer. Returns the written size on success. /// Write the unsigned enumeration to a raw buffer. Returns the written size on success.
fn write_to_be_bytes(&self, buf: &mut [u8]) -> Result<usize, ByteConversionError>; fn write_to_be_bytes(&self, buf: &mut [u8]) -> Result<usize, ByteConversionError>;
fn value(&self) -> u64;
#[cfg(feature = "alloc")]
#[cfg_attr(doc_cfg, doc(cfg(feature = "alloc")))]
fn to_vec(&self) -> alloc::vec::Vec<u8> {
let mut buf = alloc::vec![0; self.size()];
self.write_to_be_bytes(&mut buf).unwrap();
buf
}
} }
pub trait UnsignedEnumExt: UnsignedEnum + Debug + Copy + Clone + PartialEq + Eq {} pub trait UnsignedEnumExt: UnsignedEnum + Debug + Copy + Clone + PartialEq + Eq {}
@@ -132,7 +142,7 @@ impl UnsignedByteField {
Self { width, value } Self { width, value }
} }
pub fn value(&self) -> u64 { pub const fn value_const(&self) -> u64 {
self.value self.value
} }
@@ -172,6 +182,10 @@ impl UnsignedEnum for UnsignedByteField {
self.width self.width
} }
fn value(&self) -> u64 {
self.value_const()
}
fn write_to_be_bytes(&self, buf: &mut [u8]) -> Result<usize, ByteConversionError> { fn write_to_be_bytes(&self, buf: &mut [u8]) -> Result<usize, ByteConversionError> {
if buf.len() < self.size() { if buf.len() < self.size() {
return Err(ByteConversionError::ToSliceTooSmall { return Err(ByteConversionError::ToSliceTooSmall {
@@ -207,21 +221,21 @@ impl UnsignedEnum for UnsignedByteField {
#[derive(Debug, Copy, Clone, Eq, PartialEq)] #[derive(Debug, Copy, Clone, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))] #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct GenericUnsignedByteField<TYPE: Copy> { pub struct GenericUnsignedByteField<TYPE: Copy + Into<u64>> {
value: TYPE, value: TYPE,
} }
impl<TYPE: Copy> GenericUnsignedByteField<TYPE> { impl<TYPE: Copy + Into<u64>> GenericUnsignedByteField<TYPE> {
pub const fn new(val: TYPE) -> Self { pub const fn new(val: TYPE) -> Self {
Self { value: val } Self { value: val }
} }
pub const fn value(&self) -> TYPE { pub const fn value_typed(&self) -> TYPE {
self.value self.value
} }
} }
impl<TYPE: Copy + ToBeBytes> UnsignedEnum for GenericUnsignedByteField<TYPE> { impl<TYPE: Copy + ToBeBytes + Into<u64>> UnsignedEnum for GenericUnsignedByteField<TYPE> {
fn size(&self) -> usize { fn size(&self) -> usize {
self.value.written_len() self.value.written_len()
} }
@@ -233,9 +247,13 @@ impl<TYPE: Copy + ToBeBytes> UnsignedEnum for GenericUnsignedByteField<TYPE> {
expected: self.size(), expected: self.size(),
}); });
} }
buf[0..self.size()].copy_from_slice(self.value.to_be_bytes().as_ref()); buf[..self.size()].copy_from_slice(self.value.to_be_bytes().as_ref());
Ok(self.value.written_len()) Ok(self.value.written_len())
} }
fn value(&self) -> u64 {
self.value_typed().into()
}
} }
pub type UnsignedByteFieldEmpty = GenericUnsignedByteField<()>; pub type UnsignedByteFieldEmpty = GenericUnsignedByteField<()>;
@@ -351,6 +369,8 @@ pub mod tests {
for val in buf.iter().skip(1) { for val in buf.iter().skip(1) {
assert_eq!(*val, 0); assert_eq!(*val, 0);
} }
assert_eq!(u8.value_typed(), 5);
assert_eq!(u8.value(), 5);
} }
#[test] #[test]
@@ -367,6 +387,8 @@ pub mod tests {
for val in buf.iter().skip(2) { for val in buf.iter().skip(2) {
assert_eq!(*val, 0); assert_eq!(*val, 0);
} }
assert_eq!(u16.value_typed(), 3823);
assert_eq!(u16.value(), 3823);
} }
#[test] #[test]
@@ -383,6 +405,8 @@ pub mod tests {
(4..8).for_each(|i| { (4..8).for_each(|i| {
assert_eq!(buf[i], 0); assert_eq!(buf[i], 0);
}); });
assert_eq!(u32.value_typed(), 80932);
assert_eq!(u32.value(), 80932);
} }
#[test] #[test]
@@ -396,6 +420,8 @@ pub mod tests {
assert_eq!(len, 8); assert_eq!(len, 8);
let raw_val = u64::from_be_bytes(buf[0..8].try_into().unwrap()); let raw_val = u64::from_be_bytes(buf[0..8].try_into().unwrap());
assert_eq!(raw_val, 5999999); assert_eq!(raw_val, 5999999);
assert_eq!(u64.value_typed(), 5999999);
assert_eq!(u64.value(), 5999999);
} }
#[test] #[test]
@@ -534,9 +560,9 @@ pub mod tests {
u8.write_to_be_bytes(&mut buf) u8.write_to_be_bytes(&mut buf)
.expect("writing to raw buffer failed"); .expect("writing to raw buffer failed");
assert_eq!(buf[0], 5); assert_eq!(buf[0], 5);
for i in 1..8 { (1..8).for_each(|i| {
assert_eq!(buf[i], 0); assert_eq!(buf[i], 0);
} });
} }
#[test] #[test]
@@ -562,9 +588,9 @@ pub mod tests {
.expect("writing to raw buffer failed"); .expect("writing to raw buffer failed");
let raw_val = u32::from_be_bytes(buf[0..4].try_into().unwrap()); let raw_val = u32::from_be_bytes(buf[0..4].try_into().unwrap());
assert_eq!(raw_val, 80932); assert_eq!(raw_val, 80932);
for i in 4..8 { (4..8).for_each(|i| {
assert_eq!(buf[i], 0); assert_eq!(buf[i], 0);
} });
} }
#[test] #[test]