[#BloombergLP-baltzo]
= xref:BloombergLP.adoc[BloombergLP]::baltzo
:relfileprefix: ../
:mrdocs:

Package namespace for time&hyphen;zone components&period;

== Types

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/baltzo/DataFileLoader.adoc[`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&period;
| xref:BloombergLP/baltzo/DefaultZoneinfoCache.adoc[`DefaultZoneinfoCache`] 
| This struct provides a namespace for functions that manage and access the default time&hyphen;zone data cache&period;
| xref:BloombergLP/baltzo/DefaultZoneinfoCacheScopedGuard.adoc[`DefaultZoneinfoCacheScopedGuard`] 
| Upon construction, an object of this class saves the current default Zoneinfo cache and installs the user&hyphen;specified Zoneinfo cache as the default&period; On destruction, the previous default Zoneinfo cache is restored&period; This class is not even _minimally_ _thread_ _safe_&period; For terminology see `bsldoc&lowbar;glossary`&period;
| xref:BloombergLP/baltzo/DstPolicy.adoc[`DstPolicy`] 
| This `struct` provides a namespace for enumerating the set of policies for interpreting whether a local time is a daylight&hyphen;saving time&period; See `Enum` in the TYPES sub&hyphen;section for details&period;
| xref:BloombergLP/baltzo/ErrorCode.adoc[`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&period; See `Enum` in the TYPES sub&hyphen;section for details&period;
| xref:BloombergLP/baltzo/Loader.adoc[`Loader`] 
| This class provides a protocol (a pure abstract interface) for loading a time zone object&period;
| xref:BloombergLP/baltzo/LocalDatetime.adoc[`LocalDatetime`] 
| This unconstrained (value&hyphen;semantic) attribute class characterizes a date time, offset from UTC, and a time zone identifier represented by a string&period; See the  section for information on the class attributes&period;
| xref:BloombergLP/baltzo/LocalTimeDescriptor.adoc[`LocalTimeDescriptor`] 
| This simply constrained (value&hyphen;semantic) attribute class characterizes a subset of local time values&period; See the  section for information on the class attributes&period; Note that the class invariants are identically the constraints on the individual attributes&period;
| xref:BloombergLP/baltzo/LocalTimeOffsetUtil.adoc[`LocalTimeOffsetUtil`] 
| This `struct` provides a namespace for a `bdlt&colon;&colon;LocalTimeOffset` local time offset callback, and functions that manage the timezone information reported by that callback&period; All public methods are *thread&hyphen;safe*&period;
| xref:BloombergLP/baltzo/LocalTimePeriod.adoc[`LocalTimePeriod`] 
| This complex&hyphen;constrained (value&hyphen;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&period; See the  section for information on the class attributes&period; Note that the class invariants are identically the constraints on the attributes&period;
| xref:BloombergLP/baltzo/LocalTimeValidity.adoc[`LocalTimeValidity`] 
| This `struct` provides a namespace for enumerating the set of validity codes that can be attributed to local time values&period; See `Enum` in the TYPES sub&hyphen;section for details&period;
| xref:BloombergLP/baltzo/TestLoader.adoc[`TestLoader`] 
| This class provides a concrete test implementation of the `Loader` protocol (an abstract interface) for obtaining a time zone&period; This test implementation maintains a mapping of time&hyphen;zone identifiers to `Zoneinfo` objects&period; Time zone information objects are associated with a time&hyphen;zone identifier using the `setTimeZone` method, and can be subsequently accessed by calling the protocol method `loadTimeZone` with the same identifier&period;
| xref:BloombergLP/baltzo/TimeZoneUtil.adoc[`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&period;
| xref:BloombergLP/baltzo/TimeZoneUtilImp.adoc[`TimeZoneUtilImp`] 
| This `struct` provides a namespace for utility functions that convert time values to, and from, local time&period;
| xref:BloombergLP/baltzo/WindowsTimeZoneUtil.adoc[`WindowsTimeZoneUtil`] 
| This `struct` provides a namespace for utility functions that convert Zoneinfo time&hyphen;zone identifiers both to and Windows time&hyphen;zone identifiers&period;
| xref:BloombergLP/baltzo/Zoneinfo.adoc[`Zoneinfo`] 
| This class is a value&hyphen;semantic type holding a structured representation of the information contained in an Zoneinfo (or &quot;Olson&quot;) time zone database for a _single_ locale (e&period;g&period;, &quot;America&sol;New&lowbar;York&quot;)&period; The salient attributes of this type are the string identifier and the ordered sequence of `ZoneinfoTransition` objects&period;
| xref:BloombergLP/baltzo/ZoneinfoBinaryHeader.adoc[`ZoneinfoBinaryHeader`] 
| This simply constrained (value&hyphen;semantic) attribute class represents the header information found at the start of a Zoneinfo (binary) database file, which describes the contents of the file&period;
| xref:BloombergLP/baltzo/ZoneinfoBinaryReader.adoc[`ZoneinfoBinaryReader`] 
| This struct provides a namespace for functions that read Zoneinfo time zone data from a binary input stream&period; The primary method, `read`, makes use of a stream containing a Zoneinfo time zone database to populate a `Zoneinfo` object&period;
| xref:BloombergLP/baltzo/ZoneinfoCache.adoc[`ZoneinfoCache`] 
| This class provides an efficient mechanism for retrieving information about a given time zone&period; The first time a client requests information for some time&hyphen;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&period; Subsequent requests for the same time&hyphen;zone return the cached information&period; The returned values are valid for the lifetime of this object&period;
| xref:BloombergLP/baltzo/ZoneinfoTransition.adoc[`ZoneinfoTransition`] 
| This class is an unconstrained _in&hyphen;core_ value&hyphen;semantic class that characterizes a transition when the local time value of a time&hyphen;zone changes&period; The salient attributes of this type are the `utcTime` (representing seconds from UTC), and `descriptor` representing the local time value after the transition&period;
| xref:BloombergLP/baltzo/ZoneinfoUtil.adoc[`ZoneinfoUtil`] 
| This `struct` provides a namespace for utility operations using a `Zoneinfo` object&period;
|===


== Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/baltzo/swap-09f.adoc[`swap`] 
| `swap` overloads
| xref:BloombergLP/baltzo/operator_lshift-09.adoc[`operator&lt;&lt;`] 
| Stream insertion operators
| xref:BloombergLP/baltzo/operator_eq-059.adoc[`operator&equals;&equals;`] 
| Equality operators
| xref:BloombergLP/baltzo/operator_not_eq-0b.adoc[`operator!&equals;`] 
| Inequality operators
| xref:BloombergLP/baltzo/operator_lt.adoc[`operator&lt;`] 
| Return `true` if the value of the specified `lhs` is less than (ordered before) the value of the specified `rhs`&period; 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`&period;
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#
