Stdlib/std.time/DateTime

DateTime

struct DateTime

DateTime is a struct that represents a date and time.

Methods

pub fn to_timezone(self, tz: TimeZone): DateTime

Converts the DateTime to a different TimeZone.

Example

use std.time.{DateTime, TimeZone};

let t = try! DateTime.parse("2023-04-13 09:45:26.123456789 +08:00");
let tz = TimeZone.load("America/New_York")!;
let t = t.to_timezone(tz);

assert_eq t.to_string(), "2023-04-12T21:45:26.123456789-04:00";

pub fn elapsed(self): Duration

Return the time elapsed from the given time to now.

pub fn to_offset(self, offset: int): DateTime throws InvalidDateTimeError

Return this DateTime into offset.

The offset is the number of whole seconds the offset is from UTC.

use std.time.DateTime;

let t = try! DateTime.parse("2023-04-13 09:45:26.123456789 +08:00");
let utc_t = try! t.to_offset(0);
assert_eq utc_t.hour(), 1;
assert_eq utc_t.minute(), 45;
assert_eq utc_t.to_string(), "2023-04-13T01:45:26.123456789Z";

// Pacific Time
let t1 = try! t.to_offset(-28800);
assert_eq t1.hour(), 17;
assert_eq t1.minute(), 45;
assert_eq t1.to_string(), "2023-04-12T17:45:26.123456789-08:00";

// New Delhi
let t2 = try! t.to_offset(19800);
assert_eq t2.hour(), 7;
assert_eq t2.minute(), 15;
assert_eq t2.to_string(), "2023-04-13T07:15:26.123456789+05:30";

pub fn utc(self): DateTime

Return this DateTime in UTC (GMT) offset.

use std.time.DateTime;

let t = try! DateTime.parse("2023-04-13 09:45:26.123456789 +08:00");
let utc_t = t.utc();
assert_eq utc_t.hour(), 1;
assert_eq utc_t.to_string(), "2023-04-13T01:45:26.123456789Z";

pub fn operator>=:2(self, b: DateTime): bool

pub fn operator>:2(self, b: DateTime): bool

pub fn operator<=:2(self, b: DateTime): bool

pub fn operator<:2(self, b: DateTime): bool

pub fn operator!=:2(self, b: DateTime): bool

pub fn operator==:2(self, b: DateTime): bool

pub fn operator+:2(self, b: Duration): DateTime

Return time a + b (seconds) to a new DateTime.

use std.time.DateTime;

let a = try! DateTime.parse("2023-04-13 09:45:26.215");
let b = a + 873.seconds();
// "2023-04-13 09:59:00.215"

pub fn operator-:2(self, b: Duration): DateTime

Return time a - b (seconds) to a new DateTime

use std.time.DateTime;

let a = try! DateTime.parse("2023-04-13 09:59:00.123");
let b = a - 873.seconds();
// "2023-04-13 09:45:26.123"

pub fn sub(self, b: DateTime): Duration

Return a Duration of the a, b time difference.

use std.time.DateTime;

let a = try! DateTime.parse("2023-04-13 09:45:26.215");
let b = try! DateTime.parse("2023-04-13 09:59:00.123");
let seconds = b.sub(a);
// 873.908

pub fn weekday(self): int

Return int weekday of this date.

The returned value will always be in the range 1..7, Monday (1) .. Sunday (7).

use std.time.DateTime;

let t = try! DateTime.parse("2023-04-13 09:45:26.123456789 +08:00");
assert_eq t.weekday(), 4;

pub fn offset(self): int

Returns the number of whole seconds the offset is from UTC.

A positive value indicates an offset to the east; a negative to the west.

use std.time.DateTime;

let t = try! DateTime.parse("2023-04-13 09:45:26.123456789 +08:00");
assert_eq t.offset(), 28800;

pub fn set_nanosecond(self, nanosecond: int) throws InvalidDateTimeError

Set the nanosecond of this date.

pub fn nanosecond(self): int

Return int nanosecond of this date.

The returned value will always be in the range `0..1000000000``.

use std.time.DateTime;

let t = try! DateTime.parse("2023-04-13 09:45:26.123456789 +08:00");
assert_eq t.nanosecond(), 123456789;

pub fn set_microsecond(self, microsecond: int) throws InvalidDateTimeError

Set the microsecond of this date.

pub fn microsecond(self): int

Return int microsecond of this date.

The returned value will always be in the range 0..1000000.

use std.time.DateTime;

let t = try! DateTime.parse("2023-04-13 09:45:26.123456 +08:00");
assert_eq t.microsecond(), 123456;

pub fn set_millisecond(self, millisecond: int) throws InvalidDateTimeError

Set the millisecond of this date.

pub fn millisecond(self): int

Return int millisecond of this date.

The returned value will always be in the range 0..1000.

use std.time.DateTime;

let t = try! DateTime.parse("2023-04-13 09:45:26.123 +08:00");
assert_eq t.millisecond(), 123;

pub fn set_second(self, second: int) throws InvalidDateTimeError

Set the second of this date.

pub fn second(self): int

Return int second of this date.

The returned value will always be in the range 0..60.

use std.time.DateTime;

let t = try! DateTime.parse("2023-04-13 09:45:26.123 +08:00");
assert_eq t.second(), 26;

pub fn set_minute(self, minute: int) throws InvalidDateTimeError

Set the minute of this date.

pub fn minute(self): int

Return int minute of this date.

The returned value will always be in the range 0..60.

use std.time.DateTime;

let t = try! DateTime.parse("2023-04-13 09:45:26 +08:00");
assert_eq t.minute(), 45;

pub fn set_hour(self, hour: int) throws InvalidDateTimeError

Set the hour of this date.

pub fn hour(self): int

Return int hour of this date.

The returned value will always be in the range 0..24.

use std.time.DateTime;

let t = try! DateTime.parse("2023-04-13 09:45:26 +08:00");
assert_eq t.hour(), 9;
let t = try! DateTime.parse("2023-04-13 19:45:26 +08:00");
assert_eq t.hour(), 19;

pub fn set_day(self, day: int) throws InvalidDateTimeError

Set the day of this date.

pub fn day(self): int

Return int day of this date.

use std.time.DateTime;

let t = try! DateTime.parse("2023-04-13 09:45:26 +08:00");
assert_eq t.day(), 13;

pub fn set_month(self, month: int) throws InvalidDateTimeError

Set the month of this date.

pub fn month(self): int

Return int month of this date.

use std.time.DateTime;

let t = try! DateTime.parse("2023-04-13 09:45:26 +08:00");
assert_eq t.month(), 4;

pub fn set_year(self, year: int) throws InvalidDateTimeError

Set the year of this date.

pub fn year(self): int

Return int year of this date.

use std.time.DateTime;

let t = try! DateTime.parse("2023-04-13 09:45:26 +08:00");
assert_eq t.year(), 2023;

pub fn iso8601(self): string

Return the time string with the ISO 8601 format in local timezone.

If the local timezone is not available, use UTC.

nv,

use std.time.DateTime;

let t = try! DateTime.parse("2023-04-13 09:45:26 +08:00");
assert_eq t.to_string(), "2023-04-13T09:45:26+08:00";

pub fn to_string(self): string

Return the time string with the RFC3339 format in original timezone.

use std.time.DateTime;

let t = try! DateTime.parse("2023-04-13 09:45:26 +08:00");
assert_eq t.to_string(), "2023-04-13T09:45:26+08:00";

pub fn format(self, fmt: string): string?

Return the time string with the Time Format format.

If the format is invalid, return nil.

nv,

use std.time.DateTime;

let t = try! DateTime.parse("2023-04-13 09:45:26 +08:00");
assert_eq t.format("%Y-%m-%d %H:%M:%S %z"), "2023-04-13 09:45:26 +0800";
assert_eq t.format("%m/%d/%Y %H:%M"), "04/13/2023 09:45";
assert_eq t.format("invalid"), nil;

pub fn timestamp(self): int

Return the int Unix Timestamp (in second) of the time.

use std.time.DateTime;

let t = try! DateTime.parse("2023-04-13 09:45:26 +08:00");
assert_eq t.timestamp(), 1681350326;

pub fn from_timestamp(ts: int): DateTime

Return a time parse from unix timestamp (in seconds)

use std.time.DateTime;

let t = DateTime.from_timestamp(1618315526);
assert_eq t.to_string(), "2021-04-13T12:05:26Z";

pub fn now_utc(): DateTime

Return the current time in UTC.

use std.time.DateTime;

let t = DateTime.now_utc();

pub fn now_local(): DateTime

Return the current time in the local offset.

use std.time.DateTime;

let t = DateTime.now_local();

pub fn parse(time_str: string, format: string? = nil): DateTime throws ParseTimeError

Parse the time string with the Time Format format.

If the time string is not a valid time string, throw error.

Kw Args

format - Given a time format string, parse the time string with the format (default: nil), if is nil, will try to parse with the default format.

use std.time.DateTime;

let t = try! DateTime.parse("2023-04-13T14:08:33-11:00");
assert_eq t.to_string(), "2023-04-13T14:08:33-11:00";
let t = try! DateTime.parse("2023.04.13 Time: 14:08", format: "%Y.%m.%d Time: %H:%M");
assert_eq t.to_string(), "2023-04-13T14:08:00Z";