Struct icu_datetime::mock::datetime::MockDateTime

pub struct MockDateTime {
    pub year: i32,
    pub month: u32,
    pub day: u32,
    pub hour: IsoHour,
    pub minute: IsoMinute,
    pub second: IsoSecond,
}

A temporary struct that implements DateTimeInput and is used in tests, benchmarks and examples of this component.

All fields in MockDateTime are 0-based. For example, January is represented as 0, not 1.

Notice: Rust at the moment does not have a canonical way to represent date and time. We are introducing MockDateTime as an example of the data necessary for ICU DateTimeFormat to work, and we hope to work with the community to develop core date and time APIs that will work as an input for this component.

Examples

use icu::datetime::mock::datetime::MockDateTime;

let dt1 = MockDateTime::try_new(2020, 9, 24, 13, 21, 0)
    .expect("Failed to construct DateTime.");

let dt2: MockDateTime = "2020-10-14T13:21:00".parse()
    .expect("Failed to parse a datetime.");

Fields

year: i32

ISO-8601 year (proleptic Gregorian).

month: u32

0-based month index.

day: u32

0-based day index.

hour: IsoHour

0-based hour.

minute: IsoMinute

0-based minute.

second: IsoSecond

0-based second.

Implementations

impl MockDateTime

pub const fn new(
    year: i32,
    month: u32,
    day: u32,
    hour: IsoHour,
    minute: IsoMinute,
    second: IsoSecond
) -> Self

Creates a new MockDateTime from a list of already validated date/time parameters.

pub fn try_new(
    year: usize,
    month: usize,
    day: usize,
    hour: usize,
    minute: usize,
    second: usize
) -> Result<Self, DateTimeError>

Constructor for MockDateTime.

Examples

use icu::datetime::mock::datetime::MockDateTime;

let dt = MockDateTime::try_new(2020, 9, 24, 13, 21, 0)
    .expect("Failed to construct a DateTime");

Trait Implementations

impl DateInput for MockDateTime

fn year(&self) -> Option<Year>

Gets the era and year input.

fn month(&self) -> Option<Month>

Gets the month input.

fn day_of_month(&self) -> Option<DayOfMonth>

Gets the day input.

fn iso_weekday(&self) -> Option<IsoWeekday>

Gets the weekday input.

fn day_of_year_info(&self) -> Option<DayOfYearInfo>

Gets information on the position of the day within the year.

impl Debug for MockDateTime

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

Formats the value using the given formatter.

impl Default for MockDateTime

fn default() -> MockDateTime

Returns the “default value” for a type.

impl FromStr for MockDateTime

fn from_str(input: &str) -> Result<Self, Self::Err>

Parse a MockDateTime from a string.

This utility is for easily creating dates, not a complete robust solution. The string must take a specific form of the ISO-8601 format: YYYY-MM-DDThh:mm:ss.

use icu::datetime::mock::datetime::MockDateTime;

let date: MockDateTime = "2020-10-14T13:21:00".parse()
    .expect("Failed to parse a datetime.");

type Err = DateTimeError

The associated error which can be returned from parsing.

impl IsoTimeInput for MockDateTime

fn hour(&self) -> Option<IsoHour>

Gets the hour input.

fn minute(&self) -> Option<IsoMinute>

Gets the minute input.

fn second(&self) -> Option<IsoSecond>

Gets the second input.

fn fraction(&self) -> Option<FractionalSecond>

Gets the fractional second input.