hfx-core 0.3.0

Core types and manifest models for HFX (HydroFabric Exchange) datasets.
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

//! Dataset-local drainage-unit level type.

/// Errors from constructing [`Level`].
#[derive(Debug, thiserror::Error)]
pub enum LevelError {
    /// Returned when a level is negative.
    #[error("level must be non-negative, got {value}")]
    Negative {
        /// The invalid raw value.
        value: i16,
    },
}

/// Dataset-local drainage-unit resolution tier.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct Level(i16);

impl Level {
    /// Construct a [`Level`] from a raw `i16`.
    ///
    /// # Errors
    ///
    /// | Condition | Error variant |
    /// |-----------|---------------|
    /// | `raw < 0` | [`LevelError::Negative`] |
    pub fn new(raw: i16) -> Result<Self, LevelError> {
        if raw < 0 {
            return Err(LevelError::Negative { value: raw });
        }
        Ok(Self(raw))
    }

    /// Return the underlying `i16` value.
    pub fn get(self) -> i16 {
        self.0
    }
}

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

    #[test]
    fn accepts_zero() {
        let level = Level::new(0).unwrap();
        assert_eq!(level.get(), 0);
    }

    #[test]
    fn accepts_positive() {
        let level = Level::new(7).unwrap();
        assert_eq!(level.get(), 7);
    }

    #[test]
    fn rejects_negative() {
        assert!(matches!(
            Level::new(-1),
            Err(LevelError::Negative { value: -1 })
        ));
    }
}