time/error/
invalid_format_description.rs

1//! Invalid format description
2
3use alloc::string::String;
4use core::fmt;
5
6use crate::error;
7
8/// The format description provided was not valid.
9#[non_exhaustive]
10#[derive(Debug, Clone, PartialEq, Eq)]
11pub enum InvalidFormatDescription {
12    /// There was a bracket pair that was opened but not closed.
13    #[non_exhaustive]
14    UnclosedOpeningBracket {
15        /// The zero-based index of the opening bracket.
16        index: usize,
17    },
18    /// A component name is not valid.
19    #[non_exhaustive]
20    InvalidComponentName {
21        /// The name of the invalid component name.
22        name: String,
23        /// The zero-based index the component name starts at.
24        index: usize,
25    },
26    /// A modifier is not valid.
27    #[non_exhaustive]
28    InvalidModifier {
29        /// The value of the invalid modifier.
30        value: String,
31        /// The zero-based index the modifier starts at.
32        index: usize,
33    },
34    /// A component name is missing.
35    #[non_exhaustive]
36    MissingComponentName {
37        /// The zero-based index where the component name should start.
38        index: usize,
39    },
40    /// A required modifier is missing.
41    #[non_exhaustive]
42    MissingRequiredModifier {
43        /// The name of the modifier that is missing.
44        name: &'static str,
45        /// The zero-based index of the component.
46        index: usize,
47    },
48    /// Something was expected, but not found.
49    #[non_exhaustive]
50    Expected {
51        /// What was expected to be present, but wasn't.
52        what: &'static str,
53        /// The zero-based index the item was expected to be found at.
54        index: usize,
55    },
56    /// Certain behavior is not supported in the given context.
57    #[non_exhaustive]
58    NotSupported {
59        /// The behavior that is not supported.
60        what: &'static str,
61        /// The context in which the behavior is not supported.
62        context: &'static str,
63        /// The zero-based index the error occurred at.
64        index: usize,
65    },
66    /// A modifier was present more than once.
67    #[non_exhaustive]
68    DuplicateModifier {
69        /// The name of the modifier that is duplicated.
70        name: &'static str,
71        /// The zero-based index of the second occurrence of the modifier.
72        index: usize,
73    },
74}
75
76impl From<InvalidFormatDescription> for crate::Error {
77    #[inline]
78    fn from(original: InvalidFormatDescription) -> Self {
79        Self::InvalidFormatDescription(original)
80    }
81}
82
83impl TryFrom<crate::Error> for InvalidFormatDescription {
84    type Error = error::DifferentVariant;
85
86    #[inline]
87    fn try_from(err: crate::Error) -> Result<Self, Self::Error> {
88        match err {
89            crate::Error::InvalidFormatDescription(err) => Ok(err),
90            _ => Err(error::DifferentVariant),
91        }
92    }
93}
94
95impl fmt::Display for InvalidFormatDescription {
96    #[inline]
97    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
98        use InvalidFormatDescription::*;
99        match self {
100            UnclosedOpeningBracket { index } => {
101                write!(f, "unclosed opening bracket at byte index {index}")
102            }
103            InvalidComponentName { name, index } => {
104                write!(f, "invalid component name `{name}` at byte index {index}")
105            }
106            InvalidModifier { value, index } => {
107                write!(f, "invalid modifier `{value}` at byte index {index}")
108            }
109            MissingComponentName { index } => {
110                write!(f, "missing component name at byte index {index}")
111            }
112            MissingRequiredModifier { name, index } => {
113                write!(
114                    f,
115                    "missing required modifier `{name}` for component at byte index {index}"
116                )
117            }
118            Expected {
119                what: expected,
120                index,
121            } => {
122                write!(f, "expected {expected} at byte index {index}")
123            }
124            NotSupported {
125                what,
126                context,
127                index,
128            } => {
129                if context.is_empty() {
130                    write!(f, "{what} is not supported at byte index {index}")
131                } else {
132                    write!(
133                        f,
134                        "{what} is not supported in {context} at byte index {index}"
135                    )
136                }
137            }
138            DuplicateModifier { name, index } => {
139                write!(f, "duplicate modifier `{name}` at byte index {index}")
140            }
141        }
142    }
143}
144
145impl core::error::Error for InvalidFormatDescription {}
time/error/invalid_format_description.rs

time/error/
invalid_format_description.rs
