Struct icu_datetime::fieldsets::builder::FieldSetBuilder

#[non_exhaustive]
pub struct FieldSetBuilder {
    pub length: Option<Length>,
    pub date_fields: Option<DateFields>,
    pub time_precision: Option<TimePrecision>,
    pub zone_style: Option<ZoneStyle>,
    pub alignment: Option<Alignment>,
    pub year_style: Option<YearStyle>,
}

A builder for dynamic field sets.

This builder is useful if you do not know the field set at code compilation time. If you do, the static field set APIs should yield smaller binary size.

For examples, see the module docs.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

length: Option<Length>

The length of a formatted date/time string.

If None, defaults to Length::Medium.

date_fields: Option<DateFields>

The set of date fields, such as “year and month” or “weekday”.

If None, a date will not be displayed.

time_precision: Option<TimePrecision>

The precision to display the time of day.

If None, a time will not be displayed.

zone_style: Option<ZoneStyle>

The style to display the time zone.

If None, a time zone will not be displayed.

alignment: Option<Alignment>

The alignment context, such as when displaying dates in a table.

This option may be specified only if the field set can honor it.

year_style: Option<YearStyle>

How to display the year and era.

This option may be specified only if the year is included in Self::date_fields.

Implementations

impl FieldSetBuilder

pub fn build_date(self) -> Result<DateFieldSet, BuilderError>

Builds a DateFieldSet.

An error will occur if incompatible fields or options were set in the builder.

pub fn build_time(self) -> Result<TimeFieldSet, BuilderError>

Builds a TimeFieldSet.

An error will occur if incompatible fields or options were set in the builder.

pub fn build_zone(self) -> Result<ZoneFieldSet, BuilderError>

Builds a ZoneFieldSet.

An error will occur if incompatible fields or options were set in the builder.

pub fn build_date_and_time(self) -> Result<DateAndTimeFieldSet, BuilderError>

Builds a DateAndTimeFieldSet.

An error will occur if incompatible fields or options were set in the builder.

pub fn build_composite_datetime( self, ) -> Result<CompositeDateTimeFieldSet, BuilderError>

Builds a CompositeDateTimeFieldSet.

An error will occur if incompatible fields or options were set in the builder.

pub fn build_composite(self) -> Result<CompositeFieldSet, BuilderError>

Builds a CompositeFieldSet.

An error will occur if incompatible fields or options were set in the builder.

Trait Implementations

impl Clone for FieldSetBuilder

fn clone(&self) -> FieldSetBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FieldSetBuilder

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

Formats the value using the given formatter.

impl Default for FieldSetBuilder

fn default() -> FieldSetBuilder

Returns the “default value” for a type.

impl PartialEq for FieldSetBuilder

fn eq(&self, other: &FieldSetBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for FieldSetBuilder

impl StructuralPartialEq for FieldSetBuilder