Skip to content

Rename zone field sets #6096

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions components/datetime/examples/timezone_picker.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
use std::collections::BTreeMap;

use icu::calendar::Date;
use icu::datetime::{fieldsets, DateTimeFormatter};
use icu::datetime::{fieldsets, TimeFormatter};
use icu::locale::locale;
use icu::timezone::Time;

Expand All @@ -15,9 +15,11 @@ fn main() {

let prefs = locale!("en").into();

let offset_formatter = DateTimeFormatter::try_new(prefs, fieldsets::O::new()).unwrap();
let non_location_formatter = DateTimeFormatter::try_new(prefs, fieldsets::V::new()).unwrap();
let city_formatter = DateTimeFormatter::try_new(prefs, fieldsets::X::new()).unwrap();
let offset_formatter =
TimeFormatter::try_new(prefs, fieldsets::zone::LocalizedOffsetLong).unwrap();
let non_location_formatter =
TimeFormatter::try_new(prefs, fieldsets::zone::GenericLong).unwrap();
let city_formatter = TimeFormatter::try_new(prefs, fieldsets::zone::ExemplarCity).unwrap();

let reference_date = (Date::try_new_iso(2025, 1, 1).unwrap(), Time::midnight());

Expand Down
64 changes: 38 additions & 26 deletions components/datetime/src/builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -84,13 +84,13 @@
//! let static_field_set = fieldsets::T::short()
//! .with_time_precision(TimePrecision::FractionalSecond(FractionalSecondDigits::F3))
//! .with_alignment(Alignment::Column)
//! .with_zone_specific_long();
//! .zone(fieldsets::zone::SpecificLong);
//!
//! let mut builder = FieldSetBuilder::new();
//! builder.length = Some(Length::Short);
//! builder.time_precision = Some(TimePrecision::FractionalSecond(FractionalSecondDigits::F3));
//! builder.alignment = Some(Alignment::Column);
//! builder.zone_style = Some(ZoneStyle::Z);
//! builder.zone_style = Some(ZoneStyle::SpecificLong);
//! let dynamic_field_set = builder.build_composite().unwrap();
//!
//! assert_eq!(
Expand Down Expand Up @@ -157,28 +157,28 @@ pub enum DateFields {
pub enum ZoneStyle {
/// The long specific non-location format, as in
/// “Pacific Daylight Time”.
Z,
SpecificLong,
/// The short specific non-location format, as in
/// “PDT”.
Zs,
SpecificShort,
/// The long offset format, as in
/// “GMT−8:00”.
O,
LocalizedOffsetLong,
/// The short offset format, as in
/// “GMT−8”.
Os,
LocalizedOffsetShort,
/// The long generic non-location format, as in
/// “Pacific Time”.
V,
GenericLong,
/// The short generic non-location format, as in
/// “PT”.
Vs,
GenericShort,
/// The location format, as in
/// “Los Angeles time”.
L,
Location,
/// The exemplar city format, as in
/// “Los Angeles”.
X,
ExemplarCity,
}

/// An error that occurs when creating a [field set](crate::fieldsets) from a builder.
Expand Down Expand Up @@ -438,14 +438,26 @@ impl FieldSetBuilder {

fn build_zone_without_checking_options(&mut self) -> Result<ZoneFieldSet, BuilderError> {
let zone_field_set = match self.zone_style.take() {
Some(ZoneStyle::Z) => ZoneFieldSet::Z(fieldsets::Z::take_from_builder(self)),
Some(ZoneStyle::Zs) => ZoneFieldSet::Zs(fieldsets::Zs::take_from_builder(self)),
Some(ZoneStyle::O) => ZoneFieldSet::O(fieldsets::O::take_from_builder(self)),
Some(ZoneStyle::Os) => ZoneFieldSet::Os(fieldsets::Os::take_from_builder(self)),
Some(ZoneStyle::V) => ZoneFieldSet::V(fieldsets::V::take_from_builder(self)),
Some(ZoneStyle::Vs) => ZoneFieldSet::Vs(fieldsets::Vs::take_from_builder(self)),
Some(ZoneStyle::L) => ZoneFieldSet::L(fieldsets::L::take_from_builder(self)),
Some(ZoneStyle::X) => ZoneFieldSet::X(fieldsets::X::take_from_builder(self)),
Some(ZoneStyle::SpecificShort) => {
ZoneFieldSet::SpecificShort(fieldsets::zone::SpecificShort)
}
Some(ZoneStyle::SpecificLong) => {
ZoneFieldSet::SpecificLong(fieldsets::zone::SpecificLong)
}
Some(ZoneStyle::LocalizedOffsetLong) => {
ZoneFieldSet::LocalizedOffsetLong(fieldsets::zone::LocalizedOffsetLong)
}
Some(ZoneStyle::LocalizedOffsetShort) => {
ZoneFieldSet::LocalizedOffsetShort(fieldsets::zone::LocalizedOffsetShort)
}
Some(ZoneStyle::GenericLong) => ZoneFieldSet::GenericLong(fieldsets::zone::GenericLong),
Some(ZoneStyle::GenericShort) => {
ZoneFieldSet::GenericShort(fieldsets::zone::GenericShort)
}
Some(ZoneStyle::Location) => ZoneFieldSet::Location(fieldsets::zone::Location),
Some(ZoneStyle::ExemplarCity) => {
ZoneFieldSet::ExemplarCity(fieldsets::zone::ExemplarCity)
}
Option::None => return Err(BuilderError::InvalidFields),
};
Ok(zone_field_set)
Expand Down Expand Up @@ -602,14 +614,14 @@ mod tests {
&[DateFields::M, DateFields::YM, DateFields::Y];

static ZONE_STYLES: &[ZoneStyle] = &[
ZoneStyle::Z,
ZoneStyle::Zs,
ZoneStyle::O,
ZoneStyle::Os,
ZoneStyle::V,
ZoneStyle::Vs,
ZoneStyle::L,
ZoneStyle::X,
ZoneStyle::SpecificLong,
ZoneStyle::SpecificShort,
ZoneStyle::LocalizedOffsetLong,
ZoneStyle::LocalizedOffsetShort,
ZoneStyle::GenericLong,
ZoneStyle::GenericShort,
ZoneStyle::Location,
ZoneStyle::ExemplarCity,
];

#[cfg(all(feature = "serde", feature = "experimental"))]
Expand Down
26 changes: 13 additions & 13 deletions components/datetime/src/combo.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,24 @@ use crate::{provider::neo::*, scaffold::*};
/// Only one way to construct a combo field set (in this case, weekday with location-based zone):
///
/// ```
/// use icu::datetime::fieldsets::{Combo, E, L};
/// use icu::datetime::fieldsets::{Combo, E, zone::Location};
///
/// let field_set = E::long().with_zone_location();
/// let field_set = E::long().zone(Location);
/// ```
///
/// Format the weekday, hour, and location-based zone:
///
/// ```
/// use icu::datetime::fieldsets::{Combo, ET, L};
/// use icu::datetime::fieldsets::{Combo, ET, zone::Location};
/// use icu::datetime::DateTimeFormatter;
/// use icu::locale::locale;
/// use icu::timezone::ZonedDateTimeParser;
/// use writeable::assert_writeable_eq;
///
/// // Note: Combo type can be elided, but it is shown here for demonstration
/// let formatter = DateTimeFormatter::<Combo<ET, L>>::try_new(
/// let formatter = DateTimeFormatter::<Combo<ET, Location>>::try_new(
/// locale!("en-US").into(),
/// ET::short().hm().with_zone_location(),
/// ET::short().hm().zone(Location),
/// )
/// .unwrap();
///
Expand All @@ -49,16 +49,16 @@ use crate::{provider::neo::*, scaffold::*};
///
/// ```
/// use icu::calendar::Gregorian;
/// use icu::datetime::fieldsets::{Combo, ET, L};
/// use icu::datetime::fieldsets::{Combo, ET, zone::Location};
/// use icu::datetime::FixedCalendarDateTimeFormatter;
/// use icu::locale::locale;
/// use icu::timezone::{ZonedDateTimeParser, ZonedDateTime};
/// use writeable::assert_writeable_eq;
///
/// // Note: Combo type can be elided, but it is shown here for demonstration
/// let formatter = FixedCalendarDateTimeFormatter::<_, Combo<ET, L>>::try_new(
/// let formatter = FixedCalendarDateTimeFormatter::<_, Combo<ET, Location>>::try_new(
/// locale!("en-US").into(),
/// ET::short().hm().with_zone_location(),
/// ET::short().hm().zone(Location),
/// )
/// .unwrap();
///
Expand All @@ -76,16 +76,16 @@ use crate::{provider::neo::*, scaffold::*};
/// with a static time zone:
///
/// ```
/// use icu::datetime::fieldsets::{enums::DateFieldSet, Combo, Vs, YMD};
/// use icu::datetime::fieldsets::{enums::DateFieldSet, Combo, zone::GenericShort, YMD};
/// use icu::datetime::DateTimeFormatter;
/// use icu::locale::locale;
/// use icu::timezone::ZonedDateTimeParser;
/// use writeable::assert_writeable_eq;
///
/// // Note: Combo type can be elided, but it is shown here for demonstration
/// let formatter = DateTimeFormatter::<Combo<DateFieldSet, Vs>>::try_new(
/// let formatter = DateTimeFormatter::<Combo<DateFieldSet, GenericShort>>::try_new(
/// locale!("en-US").into(),
/// DateFieldSet::YMD(YMD::long()).with_zone_generic(),
/// DateFieldSet::YMD(YMD::long()).zone(GenericShort),
/// )
/// .unwrap();
///
Expand All @@ -103,15 +103,15 @@ use crate::{provider::neo::*, scaffold::*};
///
/// ```
/// use icu::calendar::Gregorian;
/// use icu::datetime::fieldsets::T;
/// use icu::datetime::fieldsets::{T, zone::SpecificLong};
/// use icu::datetime::FixedCalendarDateTimeFormatter;
/// use icu::locale::locale;
/// use icu::timezone::{ZonedDateTimeParser, ZonedDateTime};
/// use writeable::assert_writeable_eq;
///
/// let formatter = FixedCalendarDateTimeFormatter::try_new(
/// locale!("en-US").into(),
/// T::medium().with_zone_specific_long(),
/// T::medium().zone(SpecificLong),
/// )
/// .unwrap();
///
Expand Down
36 changes: 18 additions & 18 deletions components/datetime/src/dynamic.rs
Original file line number Diff line number Diff line change
Expand Up @@ -139,35 +139,35 @@ pub enum TimeFieldSet {
/// Time zone names contribute a lot of data size. For resource-constrained
/// environments, the following formats require the least amount of data:
///
/// - [`fieldsets::Zs`]
/// - [`fieldsets::O`]
/// - [`fieldsets::zone::SpecificShort`]
/// - [`fieldsets::zone::LocalizedOffsetLong`]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub enum ZoneFieldSet {
/// The long specific non-location format, as in
/// “Pacific Daylight Time”.
Z(fieldsets::Z),
SpecificLong(fieldsets::zone::SpecificLong),
/// The short specific non-location format, as in
/// “PDT”.
Zs(fieldsets::Zs),
SpecificShort(fieldsets::zone::SpecificShort),
/// The long offset format, as in
/// “GMT−8:00”.
O(fieldsets::O),
LocalizedOffsetLong(fieldsets::zone::LocalizedOffsetLong),
/// The short offset format, as in
/// “GMT−8”.
Os(fieldsets::Os),
LocalizedOffsetShort(fieldsets::zone::LocalizedOffsetShort),
/// The long generic non-location format, as in
/// “Pacific Time”.
V(fieldsets::V),
GenericLong(fieldsets::zone::GenericLong),
/// The short generic non-location format, as in
/// “PT”.
Vs(fieldsets::Vs),
GenericShort(fieldsets::zone::GenericShort),
/// The location format, as in
/// “Los Angeles Time”.
L(fieldsets::L),
Location(fieldsets::zone::Location),
/// The exemplar city format, as in
/// “Los Angeles.
X(fieldsets::X),
ExemplarCity(fieldsets::zone::ExemplarCity),
}

/// An enumeration over all possible date+time composite field sets.
Expand Down Expand Up @@ -472,14 +472,14 @@ impl_attrs! {
@zone,
ZoneFieldSet,
[
Z,
Zs,
O,
Os,
V,
Vs,
L,
X,
SpecificLong,
SpecificShort,
LocalizedOffsetLong,
LocalizedOffsetShort,
GenericLong,
GenericShort,
Location,
ExemplarCity,
]
}

Expand Down
Loading