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 286 287 288 289 290 291 292 293 294 295 296 297 298
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use std::num;
/// Contains the API configuration as prescribed by ECMA 402.
///
/// The meaning of the options is the same as in the similarly named
/// options in the JS version.
///
/// See [DateTimeFormatOptions] for the contents of the options. See the [DateTimeFormat::try_new]
/// for the use of the options.
pub mod options {
use std::fmt;
/// The date and time formatting options.
#[derive(Eq, PartialEq, Debug, Clone)]
pub enum Style {
/// Full length format style.
///
/// * Date: "Wednesday, December 19, 2012"
/// * Time: "7:00:00 PM Pacific Standard Time"
Full,
/// Long length format style.
///
/// * Date: "December 19, 2012"
/// * Time: "7:00:00 PM PST"
Long,
/// Medium length format style.
///
/// * Date: "Dec 19, 2012"
/// * Time: "7:00:00 PM"
Medium,
/// Short length format style.
///
/// * Date: "12/29/12"
/// * "7:00 PM"
Short,
}
/// Controls the calendar to use.
///
/// Possible values include: "buddhist", "chinese", " coptic", "ethiopia", "ethiopic",
/// "gregory", " hebrew", "indian", "islamic", "iso8601", " japanese", "persian", "roc".
///
/// The value entered as currency is not validated. This responsibility is
/// delegated to the implementor.
#[derive(Eq, PartialEq, Debug, Clone)]
pub struct Calendar(pub String);
impl Default for Calendar {
fn default() -> Self {
Self("gregory".into())
}
}
impl From<&str> for Calendar {
fn from(s: &str) -> Self {
Self(s.to_string())
}
}
/// The way day periods (morning, afternoon) should be expressed.
#[derive(Eq, PartialEq, Debug, Clone)]
pub enum DayPeriod {
/// "AM", "PM"
Narrow,
/// "A.M.", "P.M".
Short,
/// "Morning", "Afternoon".
Long,
}
/// Controls the number formatting.
///
/// Possible values include: "arab", "arabext", " bali", "beng", "deva", "fullwide", "gujr",
/// "guru", "hanidec", "khmr", " knda", "laoo", "latn", "limb", "mlym", " mong", "mymr",
/// "orya", "tamldec", " telu", "thai", "tibt".
///
/// The value entered is not validated. This responsibility is delegated to the implementor.
#[derive(Eq, PartialEq, Debug, Clone)]
pub struct NumberingSystem(pub String);
impl From<&str> for NumberingSystem {
fn from(s: &str) -> Self {
Self(s.to_string())
}
}
impl Default for NumberingSystem {
fn default() -> Self {
Self("latn".to_string())
}
}
/// Controls the time zone formatting.
///
/// The value entered is not validated. This responsibility is delegated to the implementor.
#[derive(Eq, PartialEq, Debug, Clone)]
pub struct TimeZone(pub String);
impl From<&str> for TimeZone {
fn from(s: &str) -> Self {
Self(s.to_string())
}
}
impl Default for TimeZone {
fn default() -> Self {
Self("UTC".to_string())
}
}
/// The hour cycle to use
#[derive(Eq, PartialEq, Debug, Clone)]
pub enum HourCycle {
/// 12 hour cycle, 0..11.
H11,
/// 12 hour cycle, 1..12.
H12,
/// 4 hour cycle, 0..23.
H23,
/// 4 hour cycle, 1..24.
H24,
}
impl fmt::Display for HourCycle {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
HourCycle::H11 => write!(f, "h11"),
HourCycle::H12 => write!(f, "h12"),
HourCycle::H23 => write!(f, "h23"),
HourCycle::H24 => write!(f, "h24"),
}
}
}
#[derive(Eq, PartialEq, Debug, Clone)]
pub enum Weekday {
/// "Thursday"
Long,
/// "Thu",
Short,
/// "T",
Narrow,
}
#[derive(Eq, PartialEq, Debug, Clone)]
pub enum Era {
/// "Anno Domini"
Long,
/// "AD",
Short,
/// "A",
Narrow,
}
#[derive(Eq, PartialEq, Debug, Clone)]
pub enum DisplaySize {
/// "2012"
Numeric,
/// "12"
TwoDigit,
}
#[derive(Eq, PartialEq, Debug, Clone)]
pub enum Month {
/// "3"
Numeric,
/// "03",
TwoDigit,
/// "March",
Long,
/// "Mar"
Short,
/// "M"
Narrow,
}
/// The time zone name styling to use.
#[derive(Eq, PartialEq, Debug, Clone)]
pub enum TimeZoneStyle {
/// "British Summer Time"
Long,
/// "GMT+1"
Short,
}
}
#[derive(Eq, PartialEq, Debug, Clone)]
pub struct DateTimeFormatOptions {
/// The formatting style to use for formatting the date part.
/// If `date_style` or `time_style` are set, none of the other options
/// are acceptable.
pub date_style: Option<options::Style>,
/// The formatting style to use for formatting the time part.
/// If `date_style` or `time_style` are set, none of the other options
/// are acceptable.
pub time_style: Option<options::Style>,
/// The number of fractional seconds to apply when calling `format`.
/// Valid values are 1 to 3.
pub fractional_second_digits: Option<num::NonZeroU8>,
/// If left unspecified, the locale default is used.
pub calendar: Option<options::Calendar>,
/// If left unspecified, the locale default is used.
pub day_period: Option<options::DayPeriod>,
/// If left unspecified, the locale default is used.
pub numbering_system: Option<options::NumberingSystem>,
/// If left unspecified, the locale default is used.
pub time_zone: Option<options::TimeZone>,
/// If left unspecified, the locale default is used.
pub hour_cycle: Option<options::HourCycle>,
/// If left unspecified, the locale default is used.
pub weekday: Option<options::Weekday>,
/// If left unspecified, the locale default is used.
pub era: Option<options::Era>,
/// If left unspecified, the locale default is used.
pub year: Option<options::DisplaySize>,
/// If left unspecified, the locale default is used.
pub month: Option<options::Month>,
/// If left unspecified, the locale default is used.
pub day: Option<options::DisplaySize>,
/// If left unspecified, the locale default is used.
pub hour: Option<options::DisplaySize>,
/// If left unspecified, the locale default is used.
pub minute: Option<options::DisplaySize>,
/// If left unspecified, the locale default is used.
pub second: Option<options::DisplaySize>,
/// If left unspecified, the locale default is used.
pub time_zone_style: Option<options::TimeZoneStyle>,
}
impl Default for DateTimeFormatOptions {
fn default() -> Self {
Self {
date_style: None,
time_style: None,
fractional_second_digits: None,
day_period: None,
numbering_system: None,
calendar: None,
time_zone: None,
hour_cycle: None,
weekday: None,
era: None,
year: None,
month: None,
day: None,
hour: None,
minute: None,
second: None,
time_zone_style: None,
}
}
}
use std::fmt;
pub trait DateTimeFormat {
/// The type of error reported, if any.
type Error: std::error::Error;
/// Creates a new [DateTimeFormat].
///
/// Creation may fail, for example, if the locale-specific data is not loaded, or if
/// the supplied options are inconsistent.
fn try_new<L>(l: L, opts: DateTimeFormatOptions) -> Result<Self, Self::Error>
where
L: crate::Locale,
Self: Sized;
/// Formats `date` into the supplied standard `writer` [fmt::Write].
///
/// The original [ECMA 402 function][ecma402fmt] returns a string. This is likely the only
/// reasonably generic option in JavaScript so it is adequate. In Rust, however, it is
/// possible to pass in a standard formatting strategy (through `writer`).
///
/// [ecma402fmt]:
/// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/format
///
/// The `date` holds the number of seconds (with fractional part) since the beginning of the
/// Unix epoch. The date is a very generic type because there is no official date-time type
/// in Rust.
fn format<W>(&self, date: f64, writer: &mut W) -> fmt::Result
where
W: fmt::Write;
}