retry 2.0.0

//! Provides a ternary result for operations.
//!
//! # Examples
//!
//! ```rust
//! # use retry::retry;
//! # use retry::delay::Fixed;
//! use retry::OperationResult;
//! let mut collection = vec![1, 2].into_iter();
//! let value = retry(Fixed::from_millis(1), || {
//!     match collection.next() {
//!         Some(n) if n == 2 => OperationResult::Ok(n),
//!         Some(_) => OperationResult::Retry("not 2"),
//!         None => OperationResult::Err("not found"),
//!     }
//! }).unwrap();
//!
//! assert_eq!(value, 2);
//! ```

/// A result that represents either success, retryable failure, or immediately-returning failure.
#[derive(Clone, Copy, PartialEq, PartialOrd, Eq, Ord, Debug, Hash)]
pub enum OperationResult<T, E> {
    /// Contains the success value.
    Ok(T),
    /// Contains the error value if duration is exceeded.
    Retry(E),
    /// Contains an error value to return immediately.
    Err(E),
}

impl<T, E> From<Result<T, E>> for OperationResult<T, E> {
    fn from(item: Result<T, E>) -> Self {
        match item {
            Ok(v) => OperationResult::Ok(v),
            Err(e) => OperationResult::Retry(e),
        }
    }
}

impl<T, E> OperationResult<T, E> {
    /// Returns `true` if the result is [`OperationResult::Ok`].
    ///
    /// # Examples
    ///
    /// Basic usage:
    ///
    /// ```
    /// # use retry::OperationResult;
    ///
    /// let x: OperationResult<i32, &str> = OperationResult::Ok(-3);
    /// assert_eq!(x.is_ok(), true);
    ///
    /// let x: OperationResult<i32, &str> = OperationResult::Retry("Some error message");
    /// assert_eq!(x.is_ok(), false);
    ///
    /// let x: OperationResult<i32, &str> = OperationResult::Err("Some other error message");
    /// assert_eq!(x.is_ok(), false);
    /// ```
    pub fn is_ok(&self) -> bool {
        matches!(self, Self::Ok(_))
    }

    /// Returns `true` if the result is [`OperationResult::Retry`].
    ///
    /// # Examples
    ///
    /// Basic usage:
    ///
    /// ```
    /// # use retry::OperationResult;
    ///
    /// let x: OperationResult<i32, &str> = OperationResult::Ok(-3);
    /// assert_eq!(x.is_retry(), false);
    ///
    /// let x: OperationResult<i32, &str> = OperationResult::Retry("Some error message");
    /// assert_eq!(x.is_retry(), true);
    ///
    /// let x: OperationResult<i32, &str> = OperationResult::Err("Some other error message");
    /// assert_eq!(x.is_retry(), false);
    /// ```
    pub fn is_retry(&self) -> bool {
        matches!(self, Self::Retry(_))
    }

    /// Returns `true` if the result is [`OperationResult::Err`].
    ///
    /// # Examples
    ///
    /// Basic usage:
    ///
    /// ```
    /// # use retry::OperationResult;
    ///
    /// let x: OperationResult<i32, &str> = OperationResult::Ok(-3);
    /// assert_eq!(x.is_err(), false);
    ///
    /// let x: OperationResult<i32, &str> = OperationResult::Retry("Some error message");
    /// assert_eq!(x.is_err(), false);
    ///
    /// let x: OperationResult<i32, &str> = OperationResult::Err("Some other error message");
    /// assert_eq!(x.is_err(), true);
    /// ```
    pub fn is_err(&self) -> bool {
        matches!(self, Self::Err(_))
    }
}