rivia 0.2.10

Rust utilities to reduce code verbosity
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

use std::{error::Error as StdError, fmt};

/// An error indicating something went wrong with a Rivia iterator operation
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub enum IterError
{
    /// An error indicating that the iterator item was not found
    ItemNotFound,

    /// An error indicating that multiple items were found for the iterator
    MultipleItemsFound,

    /// An error indicating that the indicies are mutually exclusive
    MutuallyExclusiveIndicies,
}
impl IterError
{
    /// An error indicating that the iterator item was not found
    pub fn item_not_found() -> IterError
    {
        IterError::ItemNotFound
    }

    /// An error indicating that multiple items were found for the iterator
    pub fn multiple_items_found() -> IterError
    {
        IterError::MultipleItemsFound
    }

    /// An error indicating that the indicies are mutually exclusive
    pub fn mutually_exclusive_indices() -> IterError
    {
        IterError::MutuallyExclusiveIndicies
    }
}

impl StdError for IterError {}

impl fmt::Display for IterError
{
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result
    {
        match *self {
            IterError::ItemNotFound => write!(f, "iterator item not found"),
            IterError::MultipleItemsFound => write!(f, "multiple iterator items found"),
            IterError::MutuallyExclusiveIndicies => write!(f, "mutually exclusive indices"),
        }
    }
}

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

    fn item_not_found() -> RvResult<i32>
    {
        Err(IterError::item_not_found())?
    }

    #[test]
    fn test_backtrace()
    {
        let err = item_not_found().unwrap_err();
        println!("{:?}", err)
    }

    #[test]
    fn test_item_not_found()
    {
        assert_eq!(item_not_found().unwrap_err().downcast_ref::<IterError>(), Some(&IterError::ItemNotFound));
        assert_eq!(format!("{}", IterError::item_not_found()), "iterator item not found");
    }

    #[test]
    fn test_multiple_items_found()
    {
        assert_eq!(format!("{}", IterError::multiple_items_found()), "multiple iterator items found");
    }

    #[test]
    fn test_mutually_exclusive_indices()
    {
        assert_eq!(format!("{}", IterError::mutually_exclusive_indices()), "mutually exclusive indices");
    }
}