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 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
// This file is part of ICU4X. For terms of use, please see the file
// called LICENSE at the top level of the ICU4X source tree
// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
use crate::_internal::log;
use crate::buf::BufferFormat;
use crate::prelude::*;
use core::fmt;
use displaydoc::Display;
/// A list specifying general categories of data provider error.
///
/// Errors may be caused either by a malformed request or by the data provider
/// not being able to fulfill a well-formed request.
#[derive(Clone, Copy, Eq, PartialEq, Display, Debug)]
#[non_exhaustive]
pub enum DataErrorKind {
/// No data for the provided resource key.
#[displaydoc("Missing data for key")]
MissingDataKey,
/// There is data for the key, but not for this particular locale.
#[displaydoc("Missing data for locale")]
MissingLocale,
/// The request should include a locale.
#[displaydoc("Request needs a locale")]
NeedsLocale,
/// The request should not contain a locale.
#[displaydoc("Request has an extraneous locale")]
ExtraneousLocale,
/// The resource was blocked by a filter. The resource may or may not be available.
#[displaydoc("Resource blocked by filter")]
FilteredResource,
/// The generic type parameter does not match the TypeId. The expected type name is stored
/// as context when this error is returned.
#[displaydoc("Mismatched types: tried to downcast with {0}, but actual type is different")]
MismatchedType(&'static str),
/// The payload is missing. This is usually caused by a previous error.
#[displaydoc("Missing payload")]
MissingPayload,
/// A data provider object was given to an operation in an invalid state.
#[displaydoc("Invalid state")]
InvalidState,
/// The syntax of the [`DataKey`] or [`DataLocale`] was invalid.
#[displaydoc("Parse error for data key or data locale")]
KeyLocaleSyntax,
/// An unspecified error occurred, such as a Serde error.
///
/// Check debug logs for potentially more information.
#[displaydoc("Custom")]
Custom,
/// An error occurred while accessing a system resource.
#[displaydoc("I/O error: {0:?}")]
#[cfg(feature = "std")]
Io(std::io::ErrorKind),
/// An unspecified data source containing the required data is unavailable.
#[displaydoc("Missing source data")]
#[cfg(feature = "datagen")]
MissingSourceData,
/// An error indicating that the desired buffer format is not available. This usually
/// means that a required Cargo feature was not enabled
#[displaydoc("Unavailable buffer format: {0:?} (does icu_provider need to be compiled with an additional Cargo feature?)")]
UnavailableBufferFormat(BufferFormat),
}
/// The error type for ICU4X data provider operations.
///
/// To create one of these, either start with a [`DataErrorKind`] or use [`DataError::custom()`].
///
/// # Example
///
/// Create a NeedsLocale error and attach a data request for context:
///
/// ```no_run
/// # use icu_provider::prelude::*;
/// let key: DataKey = unimplemented!();
/// let req: DataRequest = unimplemented!();
/// DataErrorKind::NeedsLocale.with_req(key, req);
/// ```
///
/// Create a named custom error:
///
/// ```
/// # use icu_provider::prelude::*;
/// DataError::custom("This is an example error");
/// ```
#[derive(Clone, Copy, Eq, PartialEq, Debug)]
#[non_exhaustive]
pub struct DataError {
/// Broad category of the error.
pub kind: DataErrorKind,
/// The data key of the request, if available.
pub key: Option<DataKey>,
/// Additional context, if available.
pub str_context: Option<&'static str>,
/// Whether this error was created in silent mode to not log.
pub silent: bool,
}
impl fmt::Display for DataError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "ICU4X data error")?;
if self.kind != DataErrorKind::Custom {
write!(f, ": {}", self.kind)?;
}
if let Some(key) = self.key {
write!(f, " (key: {key})")?;
}
if let Some(str_context) = self.str_context {
write!(f, ": {str_context}")?;
}
Ok(())
}
}
impl DataErrorKind {
/// Converts this DataErrorKind into a DataError.
///
/// If possible, you should attach context using a `with_` function.
#[inline]
pub const fn into_error(self) -> DataError {
DataError {
kind: self,
key: None,
str_context: None,
silent: false,
}
}
/// Creates a DataError with a resource key context.
#[inline]
pub const fn with_key(self, key: DataKey) -> DataError {
self.into_error().with_key(key)
}
/// Creates a DataError with a string context.
#[inline]
pub const fn with_str_context(self, context: &'static str) -> DataError {
self.into_error().with_str_context(context)
}
/// Creates a DataError with a type name context.
#[inline]
pub fn with_type_context<T>(self) -> DataError {
self.into_error().with_type_context::<T>()
}
/// Creates a DataError with a request context.
#[inline]
pub fn with_req(self, key: DataKey, req: DataRequest) -> DataError {
self.into_error().with_req(key, req)
}
}
impl DataError {
/// Returns a new, empty DataError with kind Custom and a string error message.
#[inline]
pub const fn custom(str_context: &'static str) -> Self {
Self {
kind: DataErrorKind::Custom,
key: None,
str_context: Some(str_context),
silent: false,
}
}
/// Sets the resource key of a DataError, returning a modified error.
#[inline]
pub const fn with_key(self, key: DataKey) -> Self {
Self {
kind: self.kind,
key: Some(key),
str_context: self.str_context,
silent: self.silent,
}
}
/// Sets the string context of a DataError, returning a modified error.
#[inline]
pub const fn with_str_context(self, context: &'static str) -> Self {
Self {
kind: self.kind,
key: self.key,
str_context: Some(context),
silent: self.silent,
}
}
/// Sets the string context of a DataError to the given type name, returning a modified error.
#[inline]
pub fn with_type_context<T>(self) -> Self {
if !self.silent {
log::warn!("{self}: Type context: {}", core::any::type_name::<T>());
}
self.with_str_context(core::any::type_name::<T>())
}
/// Logs the data error with the given request, returning an error containing the resource key.
///
/// If the "logging" Cargo feature is enabled, this logs the whole request. Either way,
/// it returns an error with the resource key portion of the request as context.
pub fn with_req(mut self, key: DataKey, req: DataRequest) -> Self {
if req.metadata.silent {
self.silent = true;
}
// Don't write out a log for MissingDataKey since there is no context to add
if !self.silent && self.kind != DataErrorKind::MissingDataKey {
log::warn!("{} (key: {}, request: {})", self, key, req);
}
self.with_key(key)
}
/// Logs the data error with the given context, then return self.
///
/// This does not modify the error, but if the "logging" Cargo feature is enabled,
/// it will print out the context.
#[cfg(feature = "std")]
pub fn with_path_context<P: AsRef<std::path::Path> + ?Sized>(self, _path: &P) -> Self {
if !self.silent {
log::warn!("{} (path: {:?})", self, _path.as_ref());
}
self
}
/// Logs the data error with the given context, then return self.
///
/// This does not modify the error, but if the "logging" Cargo feature is enabled,
/// it will print out the context.
#[cfg_attr(not(feature = "logging"), allow(unused_variables))]
#[inline]
pub fn with_display_context<D: fmt::Display + ?Sized>(self, context: &D) -> Self {
if !self.silent {
log::warn!("{}: {}", self, context);
}
self
}
/// Logs the data error with the given context, then return self.
///
/// This does not modify the error, but if the "logging" Cargo feature is enabled,
/// it will print out the context.
#[cfg_attr(not(feature = "logging"), allow(unused_variables))]
#[inline]
pub fn with_debug_context<D: fmt::Debug + ?Sized>(self, context: &D) -> Self {
if !self.silent {
log::warn!("{}: {:?}", self, context);
}
self
}
#[inline]
pub(crate) fn for_type<T>() -> DataError {
DataError {
kind: DataErrorKind::MismatchedType(core::any::type_name::<T>()),
key: None,
str_context: None,
silent: false,
}
}
}
#[cfg(feature = "std")]
impl std::error::Error for DataError {}
#[cfg(feature = "std")]
impl From<std::io::Error> for DataError {
fn from(e: std::io::Error) -> Self {
log::warn!("I/O error: {}", e);
DataErrorKind::Io(e.kind()).into_error()
}
}