Skip to main content

continuity_text/
range.rs

1//! Half-open ranges of [`Position`]s: `[start, end)`.
2
3use serde::{Deserialize, Serialize};
4
5use crate::Position;
6
7/// A half-open range of positions.
8#[derive(Copy, Clone, Debug, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
9pub struct Range {
10    /// Inclusive start.
11    pub start: Position,
12    /// Exclusive end.
13    pub end: Position,
14}
15
16impl Range {
17    /// Construct a range. Caller is responsible for `start <= end`.
18    #[must_use]
19    pub const fn new(start: Position, end: Position) -> Self {
20        Self { start, end }
21    }
22
23    /// An empty range at `at`.
24    #[must_use]
25    pub const fn empty(at: Position) -> Self {
26        Self { start: at, end: at }
27    }
28
29    /// `true` when start equals end.
30    #[must_use]
31    pub fn is_empty(&self) -> bool {
32        self.start == self.end
33    }
34
35    /// Return a range with `start <= end`.
36    #[must_use]
37    pub fn ordered(self) -> Self {
38        if self.start <= self.end {
39            self
40        } else {
41            Self {
42                start: self.end,
43                end: self.start,
44            }
45        }
46    }
47}
48
49#[cfg(test)]
50mod tests {
51    use super::*;
52
53    #[test]
54    fn empty_range_is_empty() {
55        let r = Range::empty(Position::new(2, 3));
56        assert!(r.is_empty());
57        assert_eq!(r.start, r.end);
58    }
59
60    #[test]
61    fn nonempty_range() {
62        let r = Range::new(Position::ZERO, Position::new(0, 5));
63        assert!(!r.is_empty());
64    }
65}