datetime_string/

error.rs

//! Datetime error.

use core::fmt;

use crate::datetime::DateError;

/// Component kind.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub(crate) enum ComponentKind {
    /// Year.
    Year,
    /// Month.
    Month,
    /// Day of month.
    Mday,
    /// Hour.
    Hour,
    /// Minute.
    Minute,
    /// Second.
    Second,
    /// Fraction part of a second.
    Secfrac,
    /// Time offset.
    Offset,
    /// Hour of time offset.
    OffsetHour,
    /// Minute of time offset.
    OffsetMinute,
}

impl ComponentKind {
    /// Returns a name of the component.
    fn as_str(&self) -> &'static str {
        match self {
            Self::Year => "year",
            Self::Month => "month",
            Self::Mday => "day of month",
            Self::Hour => "hour",
            Self::Minute => "minute",
            Self::Second => "second",
            Self::Secfrac => "secfrac",
            Self::Offset => "time offset",
            Self::OffsetHour => "time offset hour",
            Self::OffsetMinute => "time offset minute",
        }
    }
}

/// Validation error kind.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub(crate) enum ErrorKind {
    /// Invalid separator.
    InvalidSeparator,
    /// Invalid component type.
    InvalidComponentType(ComponentKind),
    /// Component value is out of range.
    ComponentOutOfRange(ComponentKind),
    /// String is too short or lacks expected following components.
    TooShort,
    /// String is too long or contains unexpected suffix.
    TooLong,
}

/// Validation error.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Error {
    /// Error kind.
    kind: ErrorKind,
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self.kind {
            ErrorKind::InvalidSeparator => write!(f, "Invalid separator"),
            ErrorKind::InvalidComponentType(component) => {
                write!(f, "Invalid component type for {}", component.as_str())
            }
            ErrorKind::ComponentOutOfRange(component) => {
                write!(f, "Out of range value for {}", component.as_str())
            }
            ErrorKind::TooShort => write!(f, "Too short"),
            ErrorKind::TooLong => write!(f, "Too long"),
        }
    }
}

#[cfg(feature = "std")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
impl std::error::Error for Error {}

impl From<ErrorKind> for Error {
    #[inline]
    fn from(kind: ErrorKind) -> Self {
        Self { kind }
    }
}

impl From<DateError> for Error {
    #[inline]
    fn from(e: DateError) -> Self {
        match e {
            DateError::MonthOutOfRange => {
                ErrorKind::ComponentOutOfRange(ComponentKind::Month).into()
            }
            DateError::MdayOutOfRange => ErrorKind::ComponentOutOfRange(ComponentKind::Mday).into(),
        }
    }
}

/// Error with value before conversion.
#[derive(Debug, Clone)]
pub struct ConversionError<T> {
    /// Conversion source value.
    value: T,
    /// Error.
    error: Error,
}

impl<T> ConversionError<T> {
    /// Creates a new error.
    #[cfg(feature = "alloc")]
    #[cfg_attr(docsrs, doc(cfg(feature = "std")))]
    #[inline]
    #[must_use]
    pub(crate) fn new<E: Into<Error>>(value: T, error: E) -> Self {
        Self {
            value,
            error: error.into(),
        }
    }

    /// Returns the inner (validation) error.
    ///
    /// # Examples
    ///
    /// ```
    /// # {
    /// // `rfc3339::FullTimeString` is only available when `alloc` feature is enabled.
    /// #![cfg(feature = "alloc")]
    ///
    /// # use datetime_string::ConversionError;
    /// use std::convert::TryFrom;
    /// use datetime_string::{Error, rfc3339::FullTimeString};
    ///
    /// let conv_err = FullTimeString::try_from("invalid time".to_owned()).unwrap_err();
    /// let _: Error = conv_err.error();
    /// # }
    /// ```
    #[inline]
    #[must_use]
    pub fn error(&self) -> Error {
        self.error
    }

    /// Returns a reference to the value, which is failed to convert.
    ///
    /// # Examples
    ///
    /// ```
    /// # {
    /// // `rfc3339::FullTimeString` is only available when `alloc` feature is enabled.
    /// #![cfg(feature = "alloc")]
    ///
    /// # use datetime_string::ConversionError;
    /// use std::convert::TryFrom;
    /// use datetime_string::{Error, rfc3339::FullTimeString};
    ///
    /// let conv_err = FullTimeString::try_from("invalid time".to_owned()).unwrap_err();
    /// let source_val: &String = conv_err.value();
    /// assert_eq!(source_val, "invalid time");
    /// # }
    /// ```
    #[inline]
    #[must_use]
    pub fn value(&self) -> &T {
        &self.value
    }

    /// Returns the value, which is failed to convert.
    ///
    /// # Examples
    ///
    /// ```
    /// # {
    /// // `rfc3339::FullTimeString` is only available when `alloc` feature is enabled.
    /// #![cfg(feature = "alloc")]
    ///
    /// # use datetime_string::ConversionError;
    /// use std::convert::TryFrom;
    /// use datetime_string::{Error, rfc3339::FullTimeString};
    ///
    /// let conv_err = FullTimeString::try_from("invalid time".to_owned()).unwrap_err();
    /// let source_val: String = conv_err.into_value();
    /// assert_eq!(source_val, "invalid time");
    /// # }
    /// ```
    #[inline]
    #[must_use]
    pub fn into_value(self) -> T {
        self.value
    }
}

impl<T: fmt::Debug> fmt::Display for ConversionError<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Failed to convert {:?}: {}", self.value, self.error)
    }
}

#[cfg(feature = "std")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
impl<T: fmt::Debug> std::error::Error for ConversionError<T> {}