toml::date_time struct

A date-time.

Constructors, destructors, conversion operators

date_time() defaulted noexcept: Default constructor. Does not initialize the members.
date_time(const toml::date& d, const toml::time& t) constexpr noexcept: Constructs a local date-time.
date_time(const toml::date& d) explicit constexpr noexcept: Constructs a local date-time.
date_time(const toml::time& t) explicit constexpr noexcept: Constructs a local date-time.
date_time(const toml::date& d, const toml::time& t, const toml::time_offset& off) constexpr noexcept: Constructs an offset date-time.

Public functions

auto is_local() const → bool constexpr noexcept: Returns true if this date_time does not contain timezone offset information.

Public variables

toml::date date: The date component.
toml::time time: The time component.
optional<toml::time_offset> offset: The timezone offset component.

Friends

auto operator!=(const date_time& lhs, const date_time& rhs) → bool constexpr noexcept: Inequality operator.
auto operator<(const date_time& lhs, const date_time& rhs) → bool constexpr noexcept: Less-than operator.
auto operator<<(std::ostream& lhs, const date_time& rhs) → std::ostream&: Prints a date_time out to a stream in RFC 3339 format.
auto operator<=(const date_time& lhs, const date_time& rhs) → bool constexpr noexcept: Less-than-or-equal-to operator.
auto operator==(const date_time& lhs, const date_time& rhs) → bool constexpr noexcept: Equality operator.
auto operator>(const date_time& lhs, const date_time& rhs) → bool constexpr noexcept: Greater-than operator.
auto operator>=(const date_time& lhs, const date_time& rhs) → bool constexpr noexcept: Greater-than-or-equal-to operator.

Function documentation

toml::date_time::date_time(const toml::date& d, const toml::time& t) constexpr noexcept

Constructs a local date-time.

Parameters
d	The date component.
t	The time component.

toml::date_time::date_time(const toml::date& d) explicit constexpr noexcept

Constructs a local date-time.

Parameters
d	The date component.

toml::date_time::date_time(const toml::time& t) explicit constexpr noexcept

Constructs a local date-time.

Parameters
t	The time component.

toml::date_time::date_time(const toml::date& d, const toml::time& t, const toml::time_offset& off) constexpr noexcept

Constructs an offset date-time.

Parameters
d	The date component.
t	The time component.
off	The timezone offset.

std::ostream& operator<<(std::ostream& lhs, const date_time& rhs)

Prints a date_time out to a stream in RFC 3339 format.

std::cout << toml::date_time{ { 1987, 3, 16 }, { 10, 20, 34 } } << "\n";
std::cout << toml::date_time{ { 1987, 3, 16 }, { 10, 20, 34 }, { -2, -30 } } << "\n";
std::cout << toml::date_time{ { 1987, 3, 16 }, { 10, 20, 34 }, {} } << "\n";

1987-03-16T10:20:34
1987-03-16T10:20:34-02:30
1987-03-16T10:20:34Z

Variable documentation

optional<toml::time_offset> toml::date_time::offset

The timezone offset component.