time

Documentation for time.

Library to handle time and date related operations.

Types

std::time::DOSDate

A type to represent a DOS date.

bitfield DOSDate { ... } [[sealed, bitfield_order]];

std::time::DOSTime

A type to represent a DOS time.

bitfield DOSTime { ... } [[sealed, bitfield_order]];

std::time::EpochTime

A type to represent a time in seconds since the epoch.

using EpochTime = ;

std::time::Time

A structured representation of a time and date.

struct Time { ... } [[sealed]];

std::time::TimeConverter

A helper type to convert between Time and u128.

union TimeConverter { ... };

std::time::TimeZone

A type to represent a time zone.

enum TimeZone :  {
    Local,
    UTC
};

Functions

std::time::epoch

Returns the current time in seconds since the epoch.

  • return: The current time in seconds since the epoch.
fn epoch();

std::time::to_local

Converts a time in seconds since the epoch to a local time.

  • epoch_time: The time in seconds since the epoch.
  • return: The local time.
fn to_local(std::time::EpochTime epoch_time);

std::time::to_utc

Converts a time in seconds since the epoch to a UTC time.

  • epoch_time: The time in seconds since the epoch.
  • return: The UTC time.
fn to_utc(std::time::EpochTime epoch_time);

std::time::now

Queries the current time in the specified time zone.

  • [time_zone]: The time zone to query. Defaults to local.
  • return: The current time in the specified time zone.
fn now(std::time::TimeZone time_zone);

std::time::to_dos_date

Converts a value to a DOS date.

  • value: The value to convert.
  • return: The DOS date.
fn to_dos_date( value);

std::time::to_dos_time

Converts a value to a DOS time.

  • value: The value to convert.
  • return: The DOS time.
fn to_dos_time( value);

std::time::filetime_to_unix

Converts a FILETIME to unix time.

  • value: The value to convert.
  • return: Timestamp formatted as unix time.
fn filetime_to_unix( value);

std::time::format

Formats a time according to the specified format string.

  • time: The time to format.
  • [format_string]: The format string to use. Defaults to "%c".
  • return: The formatted time.
fn format(std::time::Time time,  format_string);

std::time::format_dos_date

Formats a DOS date according to the specified format string.

  • date: The DOS date to format.
  • [format_string]: The format string to use. Defaults to "{}/{}/{}".
  • return: The formatted DOS date.
fn format_dos_date(std::time::DOSDate date,  format_string);

std::time::format_dos_time

Formats a DOS time according to the specified format string.

  • time: The DOS time to format.
  • [format_string]: The format string to use. Defaults to "{:02}:{:02}:{:02}".
  • return: The formatted DOS time.
fn format_dos_time(std::time::DOSTime time,  format_string);