scapegoat/tree/
error.rs

1/// Errors for fallible operations.
2#[derive(Debug, Eq, PartialEq, Copy, Clone)]
3#[non_exhaustive]
4pub enum SgError {
5    /// Cannot construct instance, maximum supported capacity exceeded.
6    MaximumCapacityExceeded,
7
8    /// Requested operation cannot complete, stack storage is full.
9    StackCapacityExceeded,
10
11    /*
12    /// Requested operation cannot complete, heap storage is full.
13    HeapCapacityExceeded,
14    */
15    /// Reserved for future use
16    #[doc(hidden)]
17    Reserved3,
18
19    /// Reserved for future use
20    #[doc(hidden)]
21    Reserved4,
22
23    /// Reserved for future use
24    #[doc(hidden)]
25    Reserved5,
26
27    /// Reserved for future use
28    #[doc(hidden)]
29    Reserved6,
30
31    /// Reserved for future use
32    #[doc(hidden)]
33    Reserved7,
34
35    /// Invalid rebalance factor requested, cannot set.
36    RebalanceFactorOutOfRange,
37}
38
39/*
40
41Requires nightly feature:
42
43#[cfg(test)]
44mod tests {
45    use crate::SgError;
46    use std::mem::variant_count;
47
48    #[test]
49    fn test_err_var_cnt() {
50        assert_eq!(variant_count::<SgError>(), 8);
51    }
52}
53*/