Struct DateTime

pub struct DateTime { /* private fields */ }

Implementations

impl DateTime

pub fn now() -> Self

Creates a new DateTime struct representing the current moment in time.

See [chrono::DateTime::now] for additional details.

pub fn from_unix_timestamp_float( unix_timestamp: f64, ) -> Result<Self, DateTimeError>

Creates a new DateTime struct from the given unix_timestamp, which is a float of seconds passed since the UNIX epoch.

This is somewhat unconventional, but fits our Luau interface and dynamic types quite well. To use this method the same way you would use a more traditional from_unix_timestamp that takes a u64 of seconds or similar type, casting the value is sufficient:

DateTime::from_unix_timestamp_float(123456789u64 as f64)

See chrono::DateTime::from_timestamp for additional details.

Errors

Returns an error if the input value is out of range.

pub fn from_universal_time( values: &DateTimeValues, ) -> Result<Self, DateTimeError>

Transforms individual date & time values into a new DateTime struct, using the universal (UTC) time zone.

See chrono::NaiveDate::from_ymd_opt and chrono::NaiveTime::from_hms_milli_opt for additional details and cases where this constructor may return an error.

Errors

Returns an error if the date or time values are invalid.

pub fn from_local_time(values: &DateTimeValues) -> Result<Self, DateTimeError>

Transforms individual date & time values into a new DateTime struct, using the current local time zone.

See chrono::NaiveDate::from_ymd_opt and chrono::NaiveTime::from_hms_milli_opt for additional details and cases where this constructor may return an error.

Errors

Returns an error if the date or time values are invalid or ambiguous.

pub fn format_string_local( &self, format: Option<&str>, locale: Option<&str>, ) -> String

Formats the DateTime using the universal (UTC) time zone, the given format string, and the given locale.

format and locale default to "%Y-%m-%d %H:%M:%S" and "en" respectively.

See [chrono_lc::DateTime::formatl] for additional details.

pub fn format_string_universal( &self, format: Option<&str>, locale: Option<&str>, ) -> String

Formats the DateTime using the universal (UTC) time zone, the given format string, and the given locale.

format and locale default to "%Y-%m-%d %H:%M:%S" and "en" respectively.

See [chrono_lc::DateTime::formatl] for additional details.

pub fn from_rfc_3339(date: impl AsRef<str>) -> Result<Self, DateTimeError>

Parses a time string in the RFC 3339 format, such as 1996-12-19T16:39:57-08:00, into a new DateTime struct.

See chrono::DateTime::parse_from_rfc3339 for additional details.

Errors

Returns an error if the input string is not a valid RFC 3339 date-time.

pub fn from_rfc_2822(date: impl AsRef<str>) -> Result<Self, DateTimeError>

Parses a time string in the RFC 2822 format, such as Tue, 1 Jul 2003 10:52:37 +0200, into a new DateTime struct.

See chrono::DateTime::parse_from_rfc2822 for additional details.

Errors

Returns an error if the input string is not a valid RFC 2822 date-time.

pub fn to_local_time(self) -> DateTimeValues

Extracts individual date & time values from this DateTime, using the current local time zone.

pub fn to_universal_time(self) -> DateTimeValues

Extracts individual date & time values from this DateTime, using the universal (UTC) time zone.

pub fn to_rfc_3339(self) -> String

Formats a time string in the RFC 3339 format, such as 1996-12-19T16:39:57-08:00.

See chrono::DateTime::to_rfc3339 for additional details.

pub fn to_rfc_2822(self) -> String

Formats a time string in the RFC 2822 format, such as Tue, 1 Jul 2003 10:52:37 +0200.

See chrono::DateTime::to_rfc2822 for additional details.

Trait Implementations

impl Clone for DateTime

fn clone(&self) -> DateTime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DateTime

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

Formats the value using the given formatter.

impl Ord for DateTime

fn cmp(&self, other: &DateTime) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DateTime

fn eq(&self, other: &DateTime) -> 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 PartialOrd for DateTime

fn partial_cmp(&self, other: &DateTime) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl UserData for DateTime

fn add_fields<F: LuaUserDataFields<Self>>(fields: &mut F)

Adds custom fields specific to this userdata.

fn add_methods<M: LuaUserDataMethods<Self>>(methods: &mut M)

Adds custom methods and operators specific to this userdata.

fn register(registry: &mut UserDataRegistry<Self>)

Registers this type for use in Lua.

impl Copy for DateTime

impl Eq for DateTime

impl StructuralPartialEq for DateTime