Revision control
Copy as Markdown
Other Tools
// 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
use displaydoc::Display;
use icu_provider::DataError;
use tinystr::{tinystr, TinyStr16, TinyStr4};
use writeable::Writeable;
#[cfg(feature = "std")]
impl std::error::Error for CalendarError {}
/// A list of error outcomes for various operations in this module.
///
/// Re-exported as [`Error`](crate::Error).
#[derive(Display, Debug, Copy, Clone, PartialEq)]
#[non_exhaustive]
pub enum CalendarError {
/// An input could not be parsed.
#[displaydoc("Could not parse as integer")]
Parse,
/// An input overflowed its range.
#[displaydoc("{field} must be between 0-{max}")]
Overflow {
/// The name of the field
field: &'static str,
/// The maximum value
max: usize,
},
#[displaydoc("{field} must be between {min}-0")]
/// An input underflowed its range.
Underflow {
/// The name of the field
field: &'static str,
/// The minimum value
min: isize,
},
/// Out of range
// TODO(Manishearth) turn this into a proper variant
OutOfRange,
/// Unknown era
#[displaydoc("No era named {0} for calendar {1}")]
UnknownEra(TinyStr16, &'static str),
/// Unknown month code for a given calendar
#[displaydoc("No month code named {0} for calendar {1}")]
UnknownMonthCode(TinyStr4, &'static str),
/// Missing required input field for formatting
#[displaydoc("No value for {0}")]
MissingInput(&'static str),
/// No support for a given calendar in AnyCalendar
#[displaydoc("AnyCalendar does not support calendar {0}")]
UnknownAnyCalendarKind(TinyStr16),
/// An operation required a calendar but a calendar was not provided.
#[displaydoc("An operation required a calendar but a calendar was not provided")]
MissingCalendar,
/// An error originating inside of the [data provider](icu_provider).
#[displaydoc("{0}")]
Data(DataError),
}
impl From<core::num::ParseIntError> for CalendarError {
fn from(_: core::num::ParseIntError) -> Self {
CalendarError::Parse
}
}
impl From<DataError> for CalendarError {
fn from(e: DataError) -> Self {
CalendarError::Data(e)
}
}
impl CalendarError {
/// Create an error when an [`AnyCalendarKind`] is expected but not available.
///
/// # Examples
///
/// ```
/// use icu::calendar::AnyCalendarKind;
/// use icu::calendar::CalendarError;
///
/// let cal_str = "maori";
///
/// AnyCalendarKind::get_for_bcp47_string(cal_str)
/// .ok_or_else(|| CalendarError::unknown_any_calendar_kind(cal_str))
/// .expect_err("Māori calendar is not yet supported");
/// ```
///
/// [`AnyCalendarKind`]: crate::AnyCalendarKind
pub fn unknown_any_calendar_kind(description: impl Writeable) -> Self {
let tiny = description
.write_to_string()
.get(0..16)
.and_then(|x| TinyStr16::from_str(x).ok())
.unwrap_or(tinystr!(16, "invalid"));
Self::UnknownAnyCalendarKind(tiny)
}
}