Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Align TimeRange struct to std::ops::Range #1461

Merged
merged 1 commit into from
Sep 20, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 44 additions & 26 deletions commons/zenoh-util/src/time_range.rs
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,18 @@ const W_TO_SECS: f64 = D_TO_SECS * 7.0;
/// The `[<start>..<end>[` pattern may however be useful to guarantee that a same timestamp never appears twice when
/// iteratively getting values for `[t0..t1[`, `[t1..t2[`, `[t2..t3[`...
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct TimeRange<T = TimeExpr>(pub TimeBound<T>, pub TimeBound<T>);
pub struct TimeRange<T = TimeExpr> {
pub start: TimeBound<T>,
pub end: TimeBound<T>,
}

impl TimeRange<TimeExpr> {
/// Resolves the offset bounds in the range using `now` as reference.
pub fn resolve_at(self, now: SystemTime) -> TimeRange<SystemTime> {
TimeRange(self.0.resolve_at(now), self.1.resolve_at(now))
TimeRange {
start: self.start.resolve_at(now),
end: self.end.resolve_at(now),
}
}

/// Resolves the offset bounds in the range using [`SystemTime::now`] as reference.
Expand All @@ -71,12 +77,12 @@ impl TimeRange<TimeExpr> {
/// [`TimeRange::<SystemTime>::contains`] instead.
pub fn contains(&self, instant: SystemTime) -> bool {
let now = SystemTime::now();
match &self.0.resolve_at(now) {
match &self.start.resolve_at(now) {
TimeBound::Inclusive(t) if t > &instant => return false,
TimeBound::Exclusive(t) if t >= &instant => return false,
_ => {}
}
match &self.1.resolve_at(now) {
match &self.end.resolve_at(now) {
TimeBound::Inclusive(t) => t >= &instant,
TimeBound::Exclusive(t) => t > &instant,
_ => true,
Expand All @@ -87,12 +93,12 @@ impl TimeRange<TimeExpr> {
impl TimeRange<SystemTime> {
/// Returns `true` if the provided `instant` belongs to `self`.
pub fn contains(&self, instant: SystemTime) -> bool {
match &self.0 {
match &self.start {
TimeBound::Inclusive(t) if *t > instant => return false,
TimeBound::Exclusive(t) if *t >= instant => return false,
_ => {}
}
match &self.1 {
match &self.end {
TimeBound::Inclusive(t) => *t >= instant,
TimeBound::Exclusive(t) => *t > instant,
_ => true,
Expand All @@ -102,25 +108,31 @@ impl TimeRange<SystemTime> {

impl From<TimeRange<SystemTime>> for TimeRange<TimeExpr> {
fn from(value: TimeRange<SystemTime>) -> Self {
TimeRange(value.0.into(), value.1.into())
TimeRange {
start: value.start.into(),
end: value.end.into(),
}
}
}

impl TryFrom<TimeRange<TimeExpr>> for TimeRange<SystemTime> {
type Error = ();
fn try_from(value: TimeRange<TimeExpr>) -> Result<Self, Self::Error> {
Ok(TimeRange(value.0.try_into()?, value.1.try_into()?))
Ok(TimeRange {
start: value.start.try_into()?,
end: value.end.try_into()?,
})
}
}

impl Display for TimeRange<TimeExpr> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match &self.0 {
match &self.start {
TimeBound::Inclusive(t) => write!(f, "[{t}..")?,
TimeBound::Exclusive(t) => write!(f, "]{t}..")?,
TimeBound::Unbounded => f.write_str("[..")?,
}
match &self.1 {
match &self.end {
TimeBound::Inclusive(t) => write!(f, "{t}]"),
TimeBound::Exclusive(t) => write!(f, "{t}["),
TimeBound::Unbounded => f.write_str("]"),
Expand All @@ -130,12 +142,12 @@ impl Display for TimeRange<TimeExpr> {

impl Display for TimeRange<SystemTime> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match &self.0 {
match &self.start {
TimeBound::Inclusive(t) => write!(f, "[{}..", TimeExpr::Fixed(*t))?,
TimeBound::Exclusive(t) => write!(f, "]{}..", TimeExpr::Fixed(*t))?,
TimeBound::Unbounded => f.write_str("[..")?,
}
match &self.1 {
match &self.end {
TimeBound::Inclusive(t) => write!(f, "{}]", TimeExpr::Fixed(*t)),
TimeBound::Exclusive(t) => write!(f, "{}[", TimeExpr::Fixed(*t)),
TimeBound::Unbounded => f.write_str("]"),
Expand Down Expand Up @@ -166,10 +178,10 @@ impl FromStr for TimeRange<TimeExpr> {

let s = &s[1..len - 1];
if let Some((start, end)) = s.split_once("..") {
Ok(TimeRange(
parse_time_bound(start, inclusive_start)?,
parse_time_bound(end, inclusive_end)?,
))
Ok(TimeRange {
start: parse_time_bound(start, inclusive_start)?,
end: parse_time_bound(end, inclusive_end)?,
})
} else if let Some((start, duration)) = s.split_once(';') {
let start_bound = parse_time_bound(start, inclusive_start)?;
let duration = parse_duration(duration)?;
Expand All @@ -186,7 +198,10 @@ impl FromStr for TimeRange<TimeExpr> {
s
),
};
Ok(TimeRange(start_bound, end_bound))
Ok(TimeRange {
start: start_bound,
end: end_bound,
})
} else {
bail!(
r#"Invalid TimeRange (must contain ".." or ";" as separator)"): {}"#,
Expand Down Expand Up @@ -485,29 +500,32 @@ mod tests {
use TimeBound::*;
assert_eq!(
"[..]".parse::<TimeRange>().unwrap(),
TimeRange(Unbounded, Unbounded)
TimeRange {
start: Unbounded,
end: Unbounded
}
);
assert_eq!(
"[now(-1h)..now(1h)]".parse::<TimeRange>().unwrap(),
TimeRange(
Inclusive(TimeExpr::Now {
TimeRange {
start: Inclusive(TimeExpr::Now {
offset_secs: -3600.0
}),
Inclusive(TimeExpr::Now {
end: Inclusive(TimeExpr::Now {
offset_secs: 3600.0
})
)
}
);
assert_eq!(
"]now(-1h)..now(1h)[".parse::<TimeRange>().unwrap(),
TimeRange(
Exclusive(TimeExpr::Now {
TimeRange {
start: Exclusive(TimeExpr::Now {
offset_secs: -3600.0
}),
Exclusive(TimeExpr::Now {
end: Exclusive(TimeExpr::Now {
offset_secs: 3600.0
})
)
}
);

assert!("".parse::<TimeExpr>().is_err());
Expand Down
Loading