std::chrono::zoned_time

 

C++

Compiler support

Freestanding and hosted

Language

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Technical specifications

Symbols index

External libraries

 

Utilities library

Language support Type support (basic types, RTTI) Library feature-test macros (C++20) Dynamic memory management Program utilities Coroutine support (C++20) Variadic functions is_constant_evaluated (C++20) launder (C++17) initializer_list (C++11) source_location (C++20) Three-way comparison (C++20) three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20)    is_eqis_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

General utilities Date and time Function objects Formatting library (C++20) bitset hash (C++11) Relational operators (deprecated in C++20) rel_ops::operator!=rel_ops::operator> rel_ops::operator<=rel_ops::operator>= Integer comparison functions cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20)    cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) Swap and type operations swap ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) Common vocabulary types pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) expected (C++23) Elementary string conversions to_chars (C++17) from_chars (C++17) chars_format (C++17)

 

Date and time utilities

Time point
time_point (C++11)	clock_time_conversion (C++20)	clock_cast (C++20)
Duration
duration (C++11)
Clocks
system_clock (C++11) steady_clock (C++11) high_resolution_clock (C++11)	is_clock (C++20) utc_clock (C++20) tai_clock (C++20)	gps_clock (C++20) file_clock (C++20) local_t (C++20)
Time of day
is_amis_pm (C++20)(C++20)	make12make24 (C++20)(C++20)	hh_mm_ss (C++20)
Calendars
day (C++20) month (C++20) year (C++20) weekday (C++20) operator/ (C++20) year_month_day (C++20)	year_month_day_last (C++20) year_month_weekday (C++20) year_month_weekday_last (C++20)       weekday_indexed (C++20) weekday_last (C++20) month_day (C++20)	month_day_last (C++20) month_weekday (C++20) month_weekday_last (C++20) year_month (C++20) last_speclast (C++20)(C++20)
Time zones
tzdb (C++20) tzdb_list (C++20) get_tzdbget_tzdb_listreload_tzdbremote_version (C++20)(C++20)(C++20)(C++20) sys_info (C++20)	local_info (C++20) nonexistent_local_time (C++20) ambiguous_local_time (C++20) locate_zone (C++20) current_zone (C++20) time_zone (C++20) choose (C++20)	zoned_traits (C++20) zoned_time (C++20) time_zone_link (C++20) leap_second (C++20) leap_second_info (C++20) get_leap_second_info (C++20)
chrono I/O
parse (C++20)
C-style date and time

 

std::chrono::zoned_time

Member functions

zoned_time::zoned_time

zoned_time::operator=

zoned_time::get_time_zone

zoned_time::get_sys_timezoned_time::operator sys_time

zoned_time::get_local_timezoned_time::operator local_time

zoned_time::get_info

Nonmember functions

operator==

operator<<

Helper classes

formatter<std::chrono::zoned_time>

Deduction guides

 

Defined in header <chrono>
template <     class Duration,     class TimeZonePtr = const std::chrono::time_zone* > class zoned_time;		(since C++20)
using zoned_seconds = std::chrono::zoned_time<std::chrono::seconds>;		(since C++20)

The class zoned_time represents a logical pairing of a time zone and a std::chrono::time_point whose resolution is Duration.

An invariant of zoned_time is that it always refers to a valid time zone and represents an existing and unambiguous time point in that time zone. Consistent with this invariant, zoned_time has no move constructor or move assignment operator; attempts to move a zoned_time will perform a copy.

The program is ill-formed if Duration is not a specialization of std::chrono::duration.

The template parameter TimeZonePtr allows users to supply their own time zone pointer types and further customize the behavior of zoned_time via std::chrono::zoned_traits. Custom time zone types need not support all the operations supported by std::chrono::time_zone, only those used by the functions actually called on the zoned_time.

TimeZonePtr must be MoveConstructible. Move-only TimeZonePtrs are allowed but difficult to use, as the zoned_time will be immovable and it is not possible to access the stored TimeZonePtr.

Member types

Member type	Definition
duration	std::common_type_t<Duration, std::chrono::seconds>

Member functions

(constructor)	constructs a zoned_time (public member function)
operator=	assigns value to a zoned_time (public member function)
get_time_zone	obtains a copy of the time zone pointer (public member function)
operator local_timeget_local_time	obtains the stored time point as a local_time (public member function)
operator sys_timeget_sys_time	obtains the stored time point as a sys_time (public member function)
get_info	obtain information about the time zone at the stored time point (public member function)

Non-member functions

operator== (C++20)	compares two zoned_time values (function template)
operator<< (C++20)	outputs a zoned_time into a stream (function template)

Helper classes

std::formatter<std::chrono::zoned_time> (C++20)

specialization of std::formatter that formats a zoned_time according to the provided format (class template specialization)

Example

Run this code

#include <chrono>
#include <iomanip>
#include <iostream>
#include <algorithm>
#include <stdexcept>
#include <string_view>
 
int main()
{
    constexpr std::string_view locations[] = {
        "Africa/Casablanca",   "America/Argentina/Buenos_Aires",
        "America/Barbados",    "America/Indiana/Petersburg",
        "America/Tarasco_Bar", "Antarctica/Casey",
        "Antarctica/Vostok",   "Asia/Magadan",
        "Asia/Manila",         "Asia/Shanghai",
        "Asia/Tokyo",          "Atlantic/Bermuda",
        "Australia/Darwin",    "Europe/Isle_of_Man",
        "Europe/Laputa",       "Indian/Christmas",
        "Indian/Cocos",        "Pacific/Galapagos",
    };
    constexpr auto width = std::ranges::max_element(locations, {},
        [](const auto& s) { return s.length(); })->length();
 
    for (const auto location : locations) {
        try {
            // may throw if `location` is not in the time zone database
            const std::chrono::zoned_time zt{location, std::chrono::system_clock::now()};
            std::cout << std::setw(width) << location << " - Zoned Time: " << zt << '\n';
        } catch (std::chrono::nonexistent_local_time& ex) {
            std::cout << "Error: " << ex.what() << '\n';
        }
    }
}

Possible output:

             Africa/Casablanca - Zoned Time: 2021-09-16 10:26:54.837665555 +01
America/Argentina/Buenos_Aires - Zoned Time: 2021-09-16 06:26:55.090150136 -03
              America/Barbados - Zoned Time: 2021-09-16 05:26:55.090419331 AST
    America/Indiana/Petersburg - Zoned Time: 2021-09-16 05:26:55.090465623 EDT
Error: America/Tarasco_Bar not found in timezone database
              Antarctica/Casey - Zoned Time: 2021-09-16 20:26:55.123070973 +11
             Antarctica/Vostok - Zoned Time: 2021-09-16 15:26:55.123151218 +06
                  Asia/Magadan - Zoned Time: 2021-09-16 20:26:55.123208852 +11
                   Asia/Manila - Zoned Time: 2021-09-16 17:26:55.123434512 PST
                 Asia/Shanghai - Zoned Time: 2021-09-16 17:26:55.123520538 CST
                    Asia/Tokyo - Zoned Time: 2021-09-16 18:26:55.123626199 JST
              Atlantic/Bermuda - Zoned Time: 2021-09-16 06:26:55.123713854 ADT
              Australia/Darwin - Zoned Time: 2021-09-16 18:56:55.155857464 ACST
            Europe/Isle_of_Man - Zoned Time: 2021-09-16 10:26:55.155909304 BST
Error: Europe/Laputa not found in timezone database
              Indian/Christmas - Zoned Time: 2021-09-16 16:26:55.215065303 +07
                  Indian/Cocos - Zoned Time: 2021-09-16 15:56:55.215137548 +0630
             Pacific/Galapagos - Zoned Time: 2021-09-16 03:26:55.215201447 -06