hgrep 0.3.9

hgrep is a grep tool with human-friendly search output. This is similar to `-C` option of `grep` command, but its output is enhanced with syntax highlighting focusing on human readable outputs.
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
87
88
89
90
91
92
93
94
95
96
97
98
99

use std::io;

// This trait is unused when only bat-printer is enabled.
#[allow(dead_code)]
pub trait IgnoreBrokenPipe {
    fn ignore_broken_pipe(self) -> Self;
}

impl<T: Default> IgnoreBrokenPipe for io::Result<T> {
    fn ignore_broken_pipe(self) -> Self {
        self.or_else(|err| {
            if err.kind() == io::ErrorKind::BrokenPipe {
                Ok(T::default())
            } else {
                Err(err)
            }
        })
    }
}

impl<T: Default> IgnoreBrokenPipe for anyhow::Result<T> {
    fn ignore_broken_pipe(self) -> Self {
        self.or_else(|err| match err.downcast_ref::<io::Error>() {
            Some(err) if err.kind() == io::ErrorKind::BrokenPipe => Ok(T::default()),
            _ => Err(err),
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::fmt;
    use std::io::Error;

    #[test]
    fn test_io_ignore_broken_pipe() {
        let err = Error::new(io::ErrorKind::BrokenPipe, "oops");
        let res = io::Result::<i32>::Err(err);
        let res = res.ignore_broken_pipe();
        assert_eq!(res.unwrap(), 0);
    }

    #[test]
    fn test_io_do_not_ignore_other_errors() {
        let err = Error::other("oops");
        let res = io::Result::<i32>::Err(err);
        let res = res.ignore_broken_pipe();
        res.unwrap_err();
    }

    #[test]
    fn test_io_do_nothing_on_ok() {
        let res = io::Result::Ok(0i32);
        let res = res.ignore_broken_pipe();
        assert_eq!(res.unwrap(), 0);
    }

    #[test]
    fn test_anyhow_ignore_broken_pipe() {
        let err = Error::new(io::ErrorKind::BrokenPipe, "oops");
        let res = io::Result::<i32>::Err(err);
        let res = res.ignore_broken_pipe();
        assert_eq!(res.unwrap(), 0);
    }

    #[test]
    fn test_anyhow_do_not_ignore_other_io_error() {
        let err = Error::other("oops");
        let res = anyhow::Result::<i32>::Err(err.into());
        let res = res.ignore_broken_pipe();
        res.unwrap_err();
    }

    #[derive(Debug)]
    struct DummyError;

    impl fmt::Display for DummyError {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            write!(f, "dummy error")
        }
    }

    impl std::error::Error for DummyError {}

    #[test]
    fn test_anyhow_do_not_ignore_other_error() {
        let res = anyhow::Result::<i32>::Err(DummyError.into());
        let res = res.ignore_broken_pipe();
        res.unwrap_err();
    }

    #[test]
    fn test_anyhow_do_nothing_on_ok() {
        let res = anyhow::Result::<i32>::Ok(0);
        let res = res.ignore_broken_pipe();
        assert_eq!(res.unwrap(), 0);
    }
}