Struct icu_datetime::format::datetime::FormattedDateTime

pub struct FormattedDateTime<'l> {
    pub(crate) datetime: ExtractedDateTimeInput,
    pub(crate) patterns: &'l DataPayload<PatternPluralsFromPatternsV1Marker>,
    pub(crate) date_symbols: Option<&'l DateSymbolsV1<'l>>,
    pub(crate) time_symbols: Option<&'l TimeSymbolsV1<'l>>,
    pub(crate) week_data: Option<&'l WeekCalculator>,
    pub(crate) ordinal_rules: Option<&'l PluralRules>,
    pub(crate) fixed_decimal_format: &'l FixedDecimalFormatter,
}

FormattedDateTime is a intermediate structure which can be retrieved as an output from TypedDateTimeFormatter.

The structure contains all the information needed to display formatted value, and it will also contain additional methods allowing the user to introspect and even manipulate the formatted data.

Examples

use icu::calendar::{DateTime, Gregorian};
use icu::datetime::TypedDateTimeFormatter;
use icu::locid::locale;
let dtf = TypedDateTimeFormatter::<Gregorian>::try_new(
    &locale!("en").into(),
    Default::default(),
)
.expect("Failed to create TypedDateTimeFormatter instance.");

let datetime = DateTime::try_new_gregorian_datetime(2020, 9, 1, 12, 34, 28)
    .expect("Failed to construct DateTime.");

let formatted_date = dtf.format(&datetime);

let _ = format!("Date: {}", formatted_date);

Fields

datetime: ExtractedDateTimeInput

patterns: &'l DataPayload<PatternPluralsFromPatternsV1Marker>

date_symbols: Option<&'l DateSymbolsV1<'l>>

time_symbols: Option<&'l TimeSymbolsV1<'l>>

week_data: Option<&'l WeekCalculator>

ordinal_rules: Option<&'l PluralRules>

fixed_decimal_format: &'l FixedDecimalFormatter

Implementations

impl<'l> FormattedDateTime<'l>

pub(crate) fn select_pattern_lossy<'a>( &'a self, ) -> (&'l Pattern<'l>, Result<(), DateTimeWriteError>)

Trait Implementations

impl<'l> Clone for FormattedDateTime<'l>

fn clone(&self) -> FormattedDateTime<'l>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'l> Debug for FormattedDateTime<'l>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'l> Display for FormattedDateTime<'l>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'l> Writeable for FormattedDateTime<'l>

fn write_to<W: Write + ?Sized>(&self, sink: &mut W) -> Result

Writes a string to the given sink. Errors from the sink are bubbled up. The default implementation delegates to write_to_parts, and discards any Part annotations.

fn write_to_parts<S>(&self, sink: &mut S) -> Result<(), Error>

where S: PartsWrite + ?Sized,

Write bytes and Part annotations to the given sink. Errors from the sink are bubbled up. The default implementation delegates to write_to, and doesn’t produce any Part annotations.

fn writeable_length_hint(&self) -> LengthHint

Returns a hint for the number of UTF-8 bytes that will be written to the sink.

fn write_to_string(&self) -> Cow<'_, str>

Creates a new String with the data from this Writeable. Like ToString, but smaller and faster.

fn writeable_cmp_bytes(&self, other: &[u8]) -> Ordering

Compares the contents of this Writeable to the given bytes without allocating a String to hold the Writeable contents.

impl<'l> Copy for FormattedDateTime<'l>