kutil 0.0.5

Kutil utilities collection
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

//
// ErrorReceiver
//

/// A receiver of errors.
///
/// Example of usage:
///
/// ```
/// fn divide<ErrorReceiverT>(a: f64, b: f64, errors: &mut ErrorReceiverT) -> Result<Option<f64>, String>
/// where
///     ErrorReceiverT: ErrorReceiver<String>,
/// {
///     Ok(if b == 0.0 {
///         errors.give("division by zero")?;
///         None
///     } else {
///         Some(a / b)
///     })
/// }
/// ```
///
/// If a generic type of this trait cannot be, e.g. within a `dyn`-compatible trait, then consider
/// using [ErrorReceiverRef](super::receiver_ref::ErrorReceiverRef) instead.
pub trait ErrorReceiver<ErrorT> {
    /// Gives an error to the receiver.
    ///
    /// Implementations may swallow the error (e.g. to accumulate it) or return it (fail-fast).
    fn give_error(&mut self, error: ErrorT) -> Result<(), ErrorT>;
}

//
// Give
//

/// Gives an error to the receiver.
pub trait Give<ErrorT> {
    /// Gives an error to the receiver.
    ///
    /// Implementations may swallow the error (e.g. to accumulate it) or return it (fail-fast).
    fn give(&mut self, error: impl Into<ErrorT>) -> Result<(), ErrorT>;
}

impl<ErrorT, ErrorReceiverT> Give<ErrorT> for ErrorReceiverT
where
    ErrorReceiverT: ErrorReceiver<ErrorT>,
{
    fn give(&mut self, error: impl Into<ErrorT>) -> Result<(), ErrorT> {
        self.give_error(error.into())
    }
}