13958601093

Committed 19 Mar 2025 04:17PM UTC coverage: 74.164% (-1.5%) from 75.71%

Build # 13958601093

Build Type

push

github

Committed by

web-flow

Commit Message

Clean up properties docs (#6315)

Run Details

58056 of 78281 relevant lines covered (74.16%)

819371.32 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

8.33

/components/datetime/src/error.rs

// 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::pattern::PatternLoadError;
use displaydoc::Display;
use icu_calendar::{
    any_calendar::AnyCalendarKind,
    types::{FormattingEra, MonthCode},
};
use icu_provider::DataError;

#[cfg(doc)]
use crate::pattern::FixedCalendarDateTimeNames;
#[cfg(doc)]
use icu_calendar::types::YearInfo;
#[cfg(doc)]
use icu_decimal::DecimalFormatter;

/// An error from constructing a formatter.
#[derive(Display, Debug, Copy, Clone, PartialEq)]
#[non_exhaustive]
pub enum DateTimeFormatterLoadError {
    /// An error while loading display names for a field.
    #[displaydoc("{0}")]
    Names(PatternLoadError),
    /// An error while loading some other required data,
    /// such as skeleton patterns or calendar conversions.
    #[displaydoc("{0}")]
    Data(DataError),
}

impl core::error::Error for DateTimeFormatterLoadError {}

impl From<DataError> for DateTimeFormatterLoadError {
    fn from(error: DataError) -> Self {
        Self::Data(error)
    }
}

/// The specific field for which an error occurred.
#[derive(Display, Debug, Copy, Clone, PartialEq)]
pub struct ErrorField(pub(crate) crate::provider::fields::Field);

/// An error from mixing calendar types in a formatter.
#[derive(Display, Debug, Copy, Clone, PartialEq)]
#[displaydoc("DateTimeFormatter for {this_kind} calendar was given a {date_kind:?} calendar")]
#[non_exhaustive]
pub struct MismatchedCalendarError {
    /// The calendar kind of the target object (formatter).
    pub this_kind: AnyCalendarKind,
    /// The calendar kind of the input object (date being formatted).
    /// Can be `None` if the input calendar was not specified.
    pub date_kind: Option<AnyCalendarKind>,
}

impl core::error::Error for MismatchedCalendarError {}

#[non_exhaustive]
#[derive(Debug, PartialEq, Copy, Clone, displaydoc::Display)]
/// Error for `TryWriteable` implementations
pub enum DateTimeWriteError {
    /// The [`MonthCode`] of the input is not valid for this calendar.
    ///
    /// This is guaranteed not to happen for `icu::calendar` inputs, but may happen for custom inputs.
    ///
    /// The output will contain the raw [`MonthCode`] as a fallback value.
    #[displaydoc("Invalid month {0:?}")]
    InvalidMonthCode(MonthCode),
    /// The [`FormattingEra`] of the input is not valid for this calendar.
    ///
    /// This is guaranteed not to happen for `icu::calendar` inputs, but may happen for custom inputs.
    ///
    /// The output will contain [`FormattingEra::fallback_name`] as the fallback.
    #[displaydoc("Invalid era {0:?}")]
    InvalidEra(FormattingEra),
    /// The [`YearInfo::cyclic`] of the input is not valid for this calendar.
    ///
    /// This is guaranteed not to happen for `icu::calendar` inputs, but may happen for custom inputs.
    ///
    /// The output will contain [`YearInfo::extended_year`] as a fallback value.
    #[displaydoc("Invalid cyclic year {value} (maximum {max})")]
    InvalidCyclicYear {
        /// Value
        value: usize,
        /// Max
        max: usize,
    },

    /// The [`DecimalFormatter`] has not been loaded.
    ///
    /// This *only* happens if the formatter has been created using
    /// [`FixedCalendarDateTimeNames::with_pattern_unchecked`], the pattern requires decimal
    /// formatting, and the decimal formatter was not loaded.
    ///
    /// The output will contain fallback values using Latin numerals.
    #[displaydoc("DecimalFormatter not loaded")]
    DecimalFormatterNotLoaded,
    /// The localized names for a field have not been loaded.
    ///
    /// This *only* happens if the formatter has been created using
    /// [`FixedCalendarDateTimeNames::with_pattern_unchecked`], and the pattern requires names
    /// that were not loaded.
    ///
    /// The output will contain fallback values using field identifiers (such as `tue` for `Weekday::Tuesday`,
    /// `M02` for month 2, etc.).
    #[displaydoc("Names for {0:?} not loaded")]
    NamesNotLoaded(ErrorField),
    /// An input field (such as "hour" or "month") is missing.
    ///
    /// This *only* happens if the formatter has been created using
    /// [`FixedCalendarDateTimeNames::with_pattern_unchecked`], and the pattern requires fields
    /// that are not returned by the input type.
    ///
    /// The output will contain the string `{X}` instead, where `X` is the symbol for which the input is missing.
    #[displaydoc("Incomplete input, missing value for {0:?}")]
    MissingInputField(&'static str),
    /// The pattern contains a field that has a valid symbol but invalid length.
    ///
    /// This *only* happens if the formatter has been created using
    /// [`FixedCalendarDateTimeNames::with_pattern_unchecked`], and the pattern contains
    /// a field with a length not supported in formatting.
    ///
    /// The output will contain fallback values similar to [`DateTimeWriteError::NamesNotLoaded`].
    #[displaydoc("Field length for {0:?} is invalid")]
    UnsupportedLength(ErrorField),
    /// Unsupported field
    ///
    /// This *only* happens if the formatter has been created using
    /// [`FixedCalendarDateTimeNames::with_pattern_unchecked`], and the pattern contains unsupported fields.
    ///
    /// The output will contain the string `{unsupported:X}`, where `X` is the symbol of the unsupported field.
    #[displaydoc("Unsupported field {0:?}")]
    UnsupportedField(ErrorField),
}

impl core::error::Error for DateTimeWriteError {}

1	// This file is part of ICU4X. For terms of use, please see the file
2	// called LICENSE at the top level of the ICU4X source tree
3	// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
4
5	use crate::pattern::PatternLoadError;
6	use displaydoc::Display;
7	use icu_calendar::{
8	any_calendar::AnyCalendarKind,
9	types::{FormattingEra, MonthCode},
10	};
11	use icu_provider::DataError;
12
13	#[cfg(doc)]
14	use crate::pattern::FixedCalendarDateTimeNames;
15	#[cfg(doc)]
16	use icu_calendar::types::YearInfo;
17	#[cfg(doc)]
18	use icu_decimal::DecimalFormatter;
19
20	/// An error from constructing a formatter.
21	#[derive(Display, Debug, Copy, Clone, PartialEq)]	×
22	#[non_exhaustive]
23	pub enum DateTimeFormatterLoadError {
24	/// An error while loading display names for a field.
25	#[displaydoc("{0}")]	×
26	Names(PatternLoadError),	×
27	/// An error while loading some other required data,
28	/// such as skeleton patterns or calendar conversions.
29	#[displaydoc("{0}")]	×
30	Data(DataError),	×
31	}
32
33	impl core::error::Error for DateTimeFormatterLoadError {}
34
35	impl From<DataError> for DateTimeFormatterLoadError {
36	fn from(error: DataError) -> Self {	×
37	Self::Data(error)	×
38	}	×
39	}
40
41	/// The specific field for which an error occurred.
42	#[derive(Display, Debug, Copy, Clone, PartialEq)]	4✔
43	pub struct ErrorField(pub(crate) crate::provider::fields::Field);	2✔
44
45	/// An error from mixing calendar types in a formatter.
46	#[derive(Display, Debug, Copy, Clone, PartialEq)]	×
47	#[displaydoc("DateTimeFormatter for {this_kind} calendar was given a {date_kind:?} calendar")]	×
48	#[non_exhaustive]
49	pub struct MismatchedCalendarError {
50	/// The calendar kind of the target object (formatter).
51	pub this_kind: AnyCalendarKind,	×
52	/// The calendar kind of the input object (date being formatted).
53	/// Can be `None` if the input calendar was not specified.
54	pub date_kind: Option<AnyCalendarKind>,	×
55	}
56
57	impl core::error::Error for MismatchedCalendarError {}
58
59	#[non_exhaustive]
60	#[derive(Debug, PartialEq, Copy, Clone, displaydoc::Display)]	×
61	/// Error for `TryWriteable` implementations
62	pub enum DateTimeWriteError {
63	/// The [`MonthCode`] of the input is not valid for this calendar.
64	///
65	/// This is guaranteed not to happen for `icu::calendar` inputs, but may happen for custom inputs.
66	///
67	/// The output will contain the raw [`MonthCode`] as a fallback value.
68	#[displaydoc("Invalid month {0:?}")]
69	InvalidMonthCode(MonthCode),	×
70	/// The [`FormattingEra`] of the input is not valid for this calendar.
71	///
72	/// This is guaranteed not to happen for `icu::calendar` inputs, but may happen for custom inputs.
73	///
74	/// The output will contain [`FormattingEra::fallback_name`] as the fallback.
75	#[displaydoc("Invalid era {0:?}")]
76	InvalidEra(FormattingEra),	×
77	/// The [`YearInfo::cyclic`] of the input is not valid for this calendar.
78	///
79	/// This is guaranteed not to happen for `icu::calendar` inputs, but may happen for custom inputs.
80	///
81	/// The output will contain [`YearInfo::extended_year`] as a fallback value.
82	#[displaydoc("Invalid cyclic year {value} (maximum {max})")]	×
83	InvalidCyclicYear {
84	/// Value
85	value: usize,	×
86	/// Max
87	max: usize,	×
88	},
89
90	/// The [`DecimalFormatter`] has not been loaded.
91	///
92	/// This only happens if the formatter has been created using
93	/// [`FixedCalendarDateTimeNames::with_pattern_unchecked`], the pattern requires decimal
94	/// formatting, and the decimal formatter was not loaded.
95	///
96	/// The output will contain fallback values using Latin numerals.
97	#[displaydoc("DecimalFormatter not loaded")]
98	DecimalFormatterNotLoaded,
99	/// The localized names for a field have not been loaded.
100	///
101	/// This only happens if the formatter has been created using
102	/// [`FixedCalendarDateTimeNames::with_pattern_unchecked`], and the pattern requires names
103	/// that were not loaded.
104	///
105	/// The output will contain fallback values using field identifiers (such as `tue` for `Weekday::Tuesday`,
106	/// `M02` for month 2, etc.).
107	#[displaydoc("Names for {0:?} not loaded")]
108	NamesNotLoaded(ErrorField),	×
109	/// An input field (such as "hour" or "month") is missing.
110	///
111	/// This only happens if the formatter has been created using
112	/// [`FixedCalendarDateTimeNames::with_pattern_unchecked`], and the pattern requires fields
113	/// that are not returned by the input type.
114	///
115	/// The output will contain the string `{X}` instead, where `X` is the symbol for which the input is missing.
116	#[displaydoc("Incomplete input, missing value for {0:?}")]
117	MissingInputField(&'static str),	×
118	/// The pattern contains a field that has a valid symbol but invalid length.
119	///
120	/// This only happens if the formatter has been created using
121	/// [`FixedCalendarDateTimeNames::with_pattern_unchecked`], and the pattern contains
122	/// a field with a length not supported in formatting.
123	///
124	/// The output will contain fallback values similar to [`DateTimeWriteError::NamesNotLoaded`].
125	#[displaydoc("Field length for {0:?} is invalid")]
126	UnsupportedLength(ErrorField),	×
127	/// Unsupported field
128	///
129	/// This only happens if the formatter has been created using
130	/// [`FixedCalendarDateTimeNames::with_pattern_unchecked`], and the pattern contains unsupported fields.
131	///
132	/// The output will contain the string `{unsupported:X}`, where `X` is the symbol of the unsupported field.
133	#[displaydoc("Unsupported field {0:?}")]
134	UnsupportedField(ErrorField),	×
135	}
136
137	impl core::error::Error for DateTimeWriteError {}

zbraniecki / icu4x / 13958601093

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous