Package namespace for time‐zone components.

Types

Name

Description

DataFileLoader

This component provides a concrete implementation of the DataLoader protocol for loading, into a Zoneinfo, the properties of a time zone defined by an Zoneinfo (TZ Database) binary file located on the file system.

DefaultZoneinfoCache

This struct provides a namespace for functions that manage and access the default time‐zone data cache.

DefaultZoneinfoCacheScopedGuard

Upon construction, an object of this class saves the current default Zoneinfo cache and installs the user‐specified Zoneinfo cache as the default. On destruction, the previous default Zoneinfo cache is restored. This class is not even minimally thread safe. For terminology see bsldoc_glossary.

DstPolicy

This struct provides a namespace for enumerating the set of policies for interpreting whether a local time is a daylight‐saving time. See Enum in the TYPES sub‐section for details.

ErrorCode

This struct provides a namespace for enumerating the set of named error codes that may be returned by functions in the baltzo package that take a Zoneinfo string identifier as input. See Enum in the TYPES sub‐section for details.

Loader

This class provides a protocol (a pure abstract interface) for loading a time zone object.

LocalDatetime

This unconstrained (value‐semantic) attribute class characterizes a date time, offset from UTC, and a time zone identifier represented by a string. See the section for information on the class attributes.

LocalTimeDescriptor

This simply constrained (value‐semantic) attribute class characterizes a subset of local time values. See the section for information on the class attributes. Note that the class invariants are identically the constraints on the individual attributes.

LocalTimeOffsetUtil

This struct provides a namespace for a bdlt::LocalTimeOffset local time offset callback, and functions that manage the timezone information reported by that callback. All public methods are thread‐safe.

LocalTimePeriod

This complex‐constrained (value‐semantic) attribute class describes a range of time in which a particular local time description (offset, DST status, and a descriptive string) is in effect. See the section for information on the class attributes. Note that the class invariants are identically the constraints on the attributes.

LocalTimeValidity

This struct provides a namespace for enumerating the set of validity codes that can be attributed to local time values. See Enum in the TYPES sub‐section for details.

TestLoader

This class provides a concrete test implementation of the Loader protocol (an abstract interface) for obtaining a time zone. This test implementation maintains a mapping of time‐zone identifiers to Zoneinfo objects. Time zone information objects are associated with a time‐zone identifier using the setTimeZone method, and can be subsequently accessed by calling the protocol method loadTimeZone with the same identifier.

TimeZoneUtil

This struct provides a namespace for utility functions that convert time values to, from, and between, their corresponding local time representations in (possibly) different time zones.

TimeZoneUtilImp

This struct provides a namespace for utility functions that convert time values to, and from, local time.

WindowsTimeZoneUtil

This struct provides a namespace for utility functions that convert Zoneinfo time‐zone identifiers both to and Windows time‐zone identifiers.

Zoneinfo

This class is a value‐semantic type holding a structured representation of the information contained in an Zoneinfo (or "Olson") time zone database for a single locale (e.g., "America/New_York"). The salient attributes of this type are the string identifier and the ordered sequence of ZoneinfoTransition objects.

ZoneinfoBinaryHeader

This simply constrained (value‐semantic) attribute class represents the header information found at the start of a Zoneinfo (binary) database file, which describes the contents of the file.

ZoneinfoBinaryReader

This struct provides a namespace for functions that read Zoneinfo time zone data from a binary input stream. The primary method, read, makes use of a stream containing a Zoneinfo time zone database to populate a Zoneinfo object.

ZoneinfoCache

This class provides an efficient mechanism for retrieving information about a given time zone. The first time a client requests information for some time‐zone identifier, that information is loaded (using the Loader supplied at construction), returned to the client (via a const pointer value), and cached for future use. Subsequent requests for the same time‐zone return the cached information. The returned values are valid for the lifetime of this object.

ZoneinfoTransition

This class is an unconstrained in‐core value‐semantic class that characterizes a transition when the local time value of a time‐zone changes. The salient attributes of this type are the utcTime (representing seconds from UTC), and descriptor representing the local time value after the transition.

ZoneinfoUtil

This struct provides a namespace for utility operations using a Zoneinfo object.

Functions

Name

Description

swap

swap overloads

operator<<

Stream insertion operators

operator==

Equality operators

operator!=

Inequality operators

operator<

Return true if the value of the specified lhs is less than (ordered before) the value of the specified rhs. Note that the value of lhs is less than the value of rhs if the value of the utcTime attribute of lhs is less than the value of the utcTime attribute of rhs.

Created with MrDocs