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    /// A combination of modifiers is not valid.
75    #[non_exhaustive]
76    InvalidModifierCombination {
77        /// The modifier that is not valid in combination with the other modifiers.
78        modifier: &'static str,
79        /// The context in which the modifier is not valid.
80        context: &'static str,
81        /// The zero-based index the error occurred at.
82        index: usize,
83    },
84}
85
86impl From<InvalidFormatDescription> for crate::Error {
87    #[inline]
88    fn from(original: InvalidFormatDescription) -> Self {
89        Self::InvalidFormatDescription(original)
90    }
91}
92
93impl TryFrom<crate::Error> for InvalidFormatDescription {
94    type Error = error::DifferentVariant;
95
96    #[inline]
97    fn try_from(err: crate::Error) -> Result<Self, Self::Error> {
98        match err {
99            crate::Error::InvalidFormatDescription(err) => Ok(err),
100            _ => Err(error::DifferentVariant),
101        }
102    }
103}
104
105impl fmt::Display for InvalidFormatDescription {
106    #[inline]
107    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
108        use InvalidFormatDescription::*;
109        match self {
110            UnclosedOpeningBracket { index } => {
111                write!(f, "unclosed opening bracket at byte index {index}")
112            }
113            InvalidComponentName { name, index } => {
114                write!(f, "invalid component name `{name}` at byte index {index}")
115            }
116            InvalidModifier { value, index } => {
117                write!(f, "invalid modifier `{value}` at byte index {index}")
118            }
119            MissingComponentName { index } => {
120                write!(f, "missing component name at byte index {index}")
121            }
122            MissingRequiredModifier { name, index } => {
123                write!(
124                    f,
125                    "missing required modifier `{name}` for component at byte index {index}"
126                )
127            }
128            Expected {
129                what: expected,
130                index,
131            } => {
132                write!(f, "expected {expected} at byte index {index}")
133            }
134            NotSupported {
135                what,
136                context,
137                index,
138            } => {
139                if context.is_empty() {
140                    write!(f, "{what} is not supported at byte index {index}")
141                } else {
142                    write!(
143                        f,
144                        "{what} is not supported in {context} at byte index {index}"
145                    )
146                }
147            }
148            DuplicateModifier { name, index } => {
149                write!(f, "duplicate modifier `{name}` at byte index {index}")
150            }
151            InvalidModifierCombination {
152                modifier,
153                context,
154                index,
155            } => write!(
156                f,
157                "the `{modifier}` modifier is not valid at byte index {index} {context}"
158            ),
159        }
160    }
161}
162
163impl core::error::Error for InvalidFormatDescription {}
time/error/invalid_format_description.rs

time/error/
invalid_format_description.rs
