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 299 300 301 302 303 304 305 306 307 308
// 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 ).
//! Options for configuring [`DurationFormatter`](crate::duration::DurationFormatter).
/// A bag of options for defining how to format duration using [`DurationFormatter`](crate::duration::DurationFormatter).
#[non_exhaustive]
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
pub struct DurationFormatterOptions {
/// The style that will be applied to units
/// unless overridden by a specific style.
pub base: BaseStyle,
/// Style for year
pub year: Option<YearStyle>,
/// Visibility control for year
pub year_visibility: Option<FieldDisplay>,
/// Style for month
pub month: Option<MonthStyle>,
/// Visibility control for month
pub month_visibility: Option<FieldDisplay>,
/// Style for week
pub week: Option<WeekStyle>,
/// Visibility control for week
pub week_visibility: Option<FieldDisplay>,
/// Style for day
pub day: Option<DayStyle>,
/// Visibility control for day
pub day_visibility: Option<FieldDisplay>,
/// Style for hour
pub hour: Option<HourStyle>,
/// Visibility control for hour
pub hour_visibility: Option<FieldDisplay>,
/// Style for minute
pub minute: Option<MinuteStyle>,
/// Visibility control for minute
pub minute_visibility: Option<FieldDisplay>,
/// Style for second
pub second: Option<SecondStyle>,
/// Visibility control for second
pub second_visibility: Option<FieldDisplay>,
/// Style for millisecond
pub millisecond: Option<MilliSecondStyle>,
/// Visibility control for millisecond
pub millisecond_visibility: Option<FieldDisplay>,
/// Style for microsecond
pub microsecond: Option<MicroSecondStyle>,
/// Visibility control for microsecond
pub microsecond_visibility: Option<FieldDisplay>,
/// Style for nanosecond
pub nanosecond: Option<NanoSecondStyle>,
/// Visibility control for nanosecond
pub nanosecond_visibility: Option<FieldDisplay>,
/// Number of fractional digits to use when formatting sub-second units (milliseconds, microseconds, nanoseconds).
/// ### Note:
/// - Only takes effect when the subsecond units are styled as `Numeric`.
/// - Zero means no fractional digits.
pub fractional_digits: FractionalDigits,
}
/// Options for configuring the number of fractional digits to display.
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
pub enum FractionalDigits {
/// Show as many fractional digits as necessary to display the whole duration,
/// omitting trailing zeroes after the decimal point.
#[default]
ShowAll,
/// Use the given number of fractional digits.
/// This value must be in the range 0..=9.
/// Fractional digits are truncated if necessary.
Fixed(u8),
}
/// Configures visibility of fields in the formatted string.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum FieldDisplay {
/// Only display this field if it is non-zero.
Auto,
/// Always display this field.
Always,
}
/// Enum used to process different unit styles in a generic way.
/// Implements `From` and `TryFrom` for all unit enums.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) enum FieldStyle {
/// Narrow style (most compact)
Narrow,
/// Short style (default)
Short,
/// Long style (most verbose)
Long,
/// Ensure formatted value is at least two digits long (by appending leading zeroes, if necessary)
TwoDigit,
/// Numeric style
Numeric,
/// Fractional style
Fractional,
/// Digital style
Digital,
}
macro_rules! derive_style {
(
$(
$(#[$enum_meta:meta])*
pub enum $enum_name: ident {
$(
$(#[$variant_meta:meta])*
$variant: ident
),* $(,)?
}
)+
) => {
$(
$(#[$enum_meta])*
pub enum $enum_name {
$(
$(#[$variant_meta])*
$variant,
)*
}
impl From<$enum_name> for FieldStyle {
fn from(style: $enum_name) -> Self {
#[allow(unreachable_patterns)]
match style {
$(
$enum_name::$variant => FieldStyle::$variant,
)*
}
}
}
impl TryFrom<FieldStyle> for $enum_name {
type Error = FieldStyle;
fn try_from(style: FieldStyle) -> Result<Self, Self::Error> {
match style {
$(
FieldStyle::$variant => Ok($enum_name::$variant),
)*
rest => Err(rest),
}
}
}
)+
};
}
derive_style! {
/// Configures the style of the duration output.
#[non_exhaustive]
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
pub enum BaseStyle {
/// Narrow style (most compact)
Narrow,
#[default]
/// Short style (default)
Short,
/// Long style (most verbose)
Long,
/// Digital formatting
Digital,
}
/// Configures the style of the year field.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum YearStyle {
/// Narrow style (most compact)
Narrow,
/// Short style (default)
Short,
/// Long style (most verbose)
Long,
}
/// Configures the style of the month field.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum MonthStyle {
/// Narrow style (most compact)
Narrow,
/// Short style (default)
Short,
/// Long style (most verbose)
Long,
}
/// Configures the style of the week field.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum WeekStyle {
/// Narrow style (most compact)
Narrow,
/// Short style (default)
Short,
/// Long style (most verbose)
Long,
}
/// Configures the style of the day field.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DayStyle {
/// Narrow style (most compact)
Narrow,
/// Short style (default)
Short,
/// Long style (most verbose)
Long,
}
/// Configures the style of the hour field.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum HourStyle {
/// Narrow style (most compact)
Narrow,
/// Short style (default)
Short,
/// Long style (most verbose)
Long,
/// Ensure formatted value is at least two digits long (by appending leading zeroes, if necessary)
TwoDigit,
/// Numeric style
Numeric,
}
/// Configures the style of the minute field.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum MinuteStyle {
/// Narrow style (most compact)
Narrow,
/// Short style (default)
Short,
/// Long style (most verbose)
Long,
/// Ensure formatted value is at least two digits long (by appending leading zeroes, if necessary)
TwoDigit,
/// Numeric style
Numeric,
}
/// Configures the style of the second field.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum SecondStyle {
/// Narrow style (most compact)
Narrow,
/// Short style (default)
Short,
/// Long style (most verbose)
Long,
/// Ensure formatted value is at least two digits long (by appending leading zeroes, if necessary)
TwoDigit,
/// Numeric style
Numeric,
}
/// Configures the style of the milliseconds field.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum MilliSecondStyle {
/// Narrow style (most compact)
Narrow,
/// Short style (default)
Short,
/// Long style (most verbose)
Long,
/// Numeric style
Numeric,
}
/// Configures the style of the microsecond field.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum MicroSecondStyle {
/// Narrow style (most compact)
Narrow,
/// Short style (default)
Short,
/// Long style (most verbose)
Long,
/// Numeric style
Numeric,
}
/// Configures the style of the nanosecond field.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum NanoSecondStyle {
/// Narrow style (most compact)
Narrow,
/// Short style (default)
Short,
/// Long style (most verbose)
Long,
/// Numeric style
Numeric,
}
}