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

Namespace for date and time types in the `bdl` package group.

== Types

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/Calendar.adoc[`Calendar`] 
| Runtime‐efficient, value‐semantic repository of weekend and holiday information.
| xref:BloombergLP/bdlt/CalendarCache.adoc[`CalendarCache`] 
| Efficient cache of read‐only `bdlt::Calendar` objects.
| xref:BloombergLP/bdlt/CalendarCache_Entry.adoc[`CalendarCache_Entry`] 
| Cache entry holding a read‐only calendar and its load time.
| xref:BloombergLP/bdlt/CalendarLoader.adoc[`CalendarLoader`] 
| Protocol for loading calendars from a specific source.
| xref:BloombergLP/bdlt/CalendarReverseIteratorAdapter.adoc[`CalendarReverseIteratorAdapter`] 
| Reverse iterator adapter for calendar iterators.
| xref:BloombergLP/bdlt/CalendarUtil.adoc[`CalendarUtil`] 
| This `struct` provides a namespace for utility functions that operate on dates in the context of supplied calendars.
| xref:BloombergLP/bdlt/Calendar_BusinessDayConstIter.adoc[`Calendar_BusinessDayConstIter`] 
| Provide read‐only, sequential access in increasing (chronological) order to the business days in a `Calendar` object.
| xref:BloombergLP/bdlt/CurrentTime.adoc[`CurrentTime`] 
| Provide a namespace for current‐time retrieval procedures.
| xref:BloombergLP/bdlt/Date.adoc[`Date`] 
| Value‐semantic type representing a date in the Unix (POSIX) calendar.
| xref:BloombergLP/bdlt/DateFormatter.adoc[`DateFormatter`] 
| This `class` provides a specifier formatter for printing `Date` objects.
| xref:BloombergLP/bdlt/DateFormatter_Cache.adoc[`DateFormatter_Cache`] 
| Cached `Date` fields for faster formatting.
| xref:BloombergLP/bdlt/DateTz.adoc[`DateTz`] 
| This value‐semantic class describes a date value in a particular time zone, which is indicated using an offset from UTC (in minutes).
| xref:BloombergLP/bdlt/DateTzFormatter.adoc[`DateTzFormatter`] 
| This `class` provides a specifier formatter for printing `DateTz` objects.
| xref:BloombergLP/bdlt/DateTzFormatter_Cache.adoc[`DateTzFormatter_Cache`] 
| Cached `DateTz` fields for faster formatting.
| xref:BloombergLP/bdlt/DateUtil.adoc[`DateUtil`] 
| This `struct` provides a namespace for utility functions that provide non‐primitive operations on dates.
| xref:BloombergLP/bdlt/Datetime.adoc[`Datetime`] 
| Value‐semantic type representing a date and a time of day.
| xref:BloombergLP/bdlt/DatetimeFormatter.adoc[`DatetimeFormatter`] 
| This `class` provides a specifier formatter for printing `Datetime` objects.
| xref:BloombergLP/bdlt/DatetimeFormatter_Cache.adoc[`DatetimeFormatter_Cache`] 
| Cached `Datetime` fields for faster formatting.
| xref:BloombergLP/bdlt/DatetimeImpUtil.adoc[`DatetimeImpUtil`] 
| This `struct` provides a namespace for datetime encoding constants.
| xref:BloombergLP/bdlt/DatetimeInterval.adoc[`DatetimeInterval`] 
| Each object of this class represents a (signed) time interval with microsecond resolution. See {The Representation of a Time Interval} for details.
| xref:BloombergLP/bdlt/DatetimeIntervalUtil.adoc[`DatetimeIntervalUtil`] 
| This utility `struct` provides a namespace for a suite of functions operating on objects of type `DatetimeInterval`.
| xref:BloombergLP/bdlt/DatetimeTz.adoc[`DatetimeTz`] 
| This value‐semantic class describes a datetime value in a particular time zone, which is indicated using an offset from UTC (in minutes).
| xref:BloombergLP/bdlt/DatetimeTzFormatter.adoc[`DatetimeTzFormatter`] 
| This `class` provides a specifier formatter for printing `DatetimeTz` objects.
| xref:BloombergLP/bdlt/DatetimeTzFormatter_Cache.adoc[`DatetimeTzFormatter_Cache`] 
| Cached `DatetimeTz` fields for faster formatting.
| xref:BloombergLP/bdlt/DatetimeUtil.adoc[`DatetimeUtil`] 
| This utility `struct` provides a namespace for a suite of functions operating on objects of type `Datetime`.
| xref:BloombergLP/bdlt/DayOfWeek.adoc[`DayOfWeek`] 
| This `struct` provides a namespace for enumerating day‐of‐week values. See `Enum` in the TYPES sub‐section for details.
| xref:BloombergLP/bdlt/DayOfWeekSet.adoc[`DayOfWeekSet`] 
| This class implements an efficient value‐semantic, ordered set of `DayOfWeek` values.
| xref:BloombergLP/bdlt/DayOfWeekSet_Iter.adoc[`DayOfWeekSet_Iter`] 
| Bidirectional iterator over the members of a `DayOfWeekSet`.
| xref:BloombergLP/bdlt/DayOfWeekUtil.adoc[`DayOfWeekUtil`] 
| This `struct` provides a namespace for common non‐primitive procedures that operate on `bdlt::DayOfWeek::Enum` values.
| xref:BloombergLP/bdlt/DefaultCalendarCache.adoc[`DefaultCalendarCache`] 
| Manage the process‐wide default `CalendarCache`.
| xref:BloombergLP/bdlt/DefaultTimetableCache.adoc[`DefaultTimetableCache`] 
| Manage the process‐wide default `TimetableCache`.
| xref:BloombergLP/bdlt/EpochUtil.adoc[`EpochUtil`] 
| Provide conversions between absolute datetimes and epoch‐relative intervals.
| xref:BloombergLP/bdlt/FixUtil.adoc[`FixUtil`] 
| Namespace for conversions between `bdlt` types and their FIX representations.
| xref:BloombergLP/bdlt/FixUtilConfiguration.adoc[`FixUtilConfiguration`] 
| This unconstrained (value‐semantic) attribute class characterizes how to configure certain behavior in `FixUtil` functions.
| xref:BloombergLP/bdlt/FormatTestUtil.adoc[`FormatTestUtil`] 
| Namespace for static functions that test formatting of `bdlt` value types.
| xref:BloombergLP/bdlt/FormatUtil.adoc[`FormatUtil`] 
| This `class` serves as a namespace for some static functions that are useful in creating specializations of `bsl::formatter` to support `bsl::format`.
| xref:BloombergLP/bdlt/Formatter.adoc[`Formatter`] 
| Parse format specifications and format values using the specified `tt_SPECIFIER_FORMATTER` template class.
| xref:BloombergLP/bdlt/FuzzUtil.adoc[`FuzzUtil`] 
| This utility `struct` provides a namespace for a suite of functions that produce objects of date and time values from fuzz data.
| xref:BloombergLP/bdlt/IntervalConversionUtil.adoc[`IntervalConversionUtil`] 
| This utility `struct` provides functions to convert between time‐interval representations.
| xref:BloombergLP/bdlt/Iso8601Util.adoc[`Iso8601Util`] 
| Utility for converting between `bdlt` types and ISO 8601 strings.
| xref:BloombergLP/bdlt/Iso8601UtilConfiguration.adoc[`Iso8601UtilConfiguration`] 
| This unconstrained (value‐semantic) attribute class characterizes how to configure certain behavior in `Iso8601Util` functions.
| xref:BloombergLP/bdlt/Iso8601UtilParseConfiguration.adoc[`Iso8601UtilParseConfiguration`] 
| This unconstrained (value‐semantic) attribute class characterizes how to configure certain behavior in `Iso8601Util` functions.
| xref:BloombergLP/bdlt/Literal_SpecifierFormatter.adoc[`Literal_SpecifierFormatter`] 
| This `class` does parsing and output of sequences whose corresponding output is independent of the type and value of the object being formatted.
| xref:BloombergLP/bdlt/LocalTimeOffset.adoc[`LocalTimeOffset`] 
| Provide a namespace for local‐time‐offset procedures.
| xref:BloombergLP/bdlt/MonthOfYear.adoc[`MonthOfYear`] 
| This `struct` provides a namespace for enumerating month‐of‐year values. See `Enum` in the TYPES sub‐section for details.
| xref:BloombergLP/bdlt/PackedCalendar.adoc[`PackedCalendar`] 
| Space‐efficient, value‐semantic repository of weekend and holiday information.
| xref:BloombergLP/bdlt/PackedCalendar_BusinessDayConstIterator.adoc[`PackedCalendar_BusinessDayConstIterator`] 
| Provide read‐only, sequential access in increasing (chronological) order to the business days in a `PackedCalendar` object.
| xref:BloombergLP/bdlt/PackedCalendar_DateProxy.adoc[`PackedCalendar_DateProxy`] 
| Proxy for `Date` used by calendar iterator arrow operators.
| xref:BloombergLP/bdlt/PackedCalendar_DateRef.adoc[`PackedCalendar_DateRef`] 
| Reference to a `Date` for holiday and business‐day iterators.
| xref:BloombergLP/bdlt/PackedCalendar_HolidayCodeConstIterator.adoc[`PackedCalendar_HolidayCodeConstIterator`] 
| Provide read‐only, sequential access in increasing (numerical) order to the holiday codes in a `PackedCalendar` object.
| xref:BloombergLP/bdlt/PackedCalendar_HolidayConstIterator.adoc[`PackedCalendar_HolidayConstIterator`] 
| Sequential, read‐only iterator over holidays in a `PackedCalendar`.
| xref:BloombergLP/bdlt/PosixDateImpUtil.adoc[`PosixDateImpUtil`] 
| Namespace for low‐level POSIX‐calendar date conversion utilities.
| xref:BloombergLP/bdlt/ProlepticDateImpUtil.adoc[`ProlepticDateImpUtil`] 
| Provide low‐level support functions for proleptic Gregorian dates.
| xref:BloombergLP/bdlt/Time.adoc[`Time`] 
| Value‐semantic type representing the time of day to microsecond resolution.
| xref:BloombergLP/bdlt/TimeFormatter.adoc[`TimeFormatter`] 
| This `class` provides a specifier formatter for printing `Time` objects.
| xref:BloombergLP/bdlt/TimeFormatter_Cache.adoc[`TimeFormatter_Cache`] 
| Cached `Time` fields for faster formatting.
| xref:BloombergLP/bdlt/TimeTz.adoc[`TimeTz`] 
| This value‐semantic class describes a time value in a particular time zone, which is indicated using an offset from UTC (in minutes).
| xref:BloombergLP/bdlt/TimeTzFormatter.adoc[`TimeTzFormatter`] 
| This `class` provides a specifier formatter for printing `TimeTz` objects.
| xref:BloombergLP/bdlt/TimeTzFormatter_Cache.adoc[`TimeTzFormatter_Cache`] 
| Cached `TimeTz` fields for faster formatting.
| xref:BloombergLP/bdlt/TimeUnitRatio.adoc[`TimeUnitRatio`] 
| This `struct` provides a namespace for constants characterizing ratios between commonly‐used time units.
| xref:BloombergLP/bdlt/TimeUtil.adoc[`TimeUtil`] 
| This `struct` provides a namespace for common non‐primitive procedures that operate on `Time` objects. These methods are alias‐safe and exception‐neutral.
| xref:BloombergLP/bdlt/TimeZoneFormatter.adoc[`TimeZoneFormatter`] 
| This `class` provides a specifier formatter for printing time zones.
| xref:BloombergLP/bdlt/Timetable.adoc[`Timetable`] 
| Value‐semantic repository of datetime‐indexed state transitions.
| xref:BloombergLP/bdlt/TimetableCache.adoc[`TimetableCache`] 
| Efficient cache of read‐only `bdlt::Timetable` objects.
| xref:BloombergLP/bdlt/TimetableCache_Entry.adoc[`TimetableCache_Entry`] 
| Cache entry holding a read‐only timetable and its load time.
| xref:BloombergLP/bdlt/TimetableLoader.adoc[`TimetableLoader`] 
| Protocol for loading timetables from a specific source.
| xref:BloombergLP/bdlt/TimetableTransition.adoc[`TimetableTransition`] 
| Datetime‐indexed state transition with an associated code.
| xref:BloombergLP/bdlt/TimetableTransition_Ref.adoc[`TimetableTransition_Ref`] 
| Proxy reference used by timetable iterator arrow operators.
| xref:BloombergLP/bdlt/Timetable_CompactableTransition.adoc[`Timetable_CompactableTransition`] 
| Time‐of‐day state transition with an associated code.
| xref:BloombergLP/bdlt/Timetable_ConstIterator.adoc[`Timetable_ConstIterator`] 
| Provide read‐only, sequential access in increasing (chronological) order to the transitions in a `Timetable` object.
| xref:BloombergLP/bdlt/Timetable_Day.adoc[`Timetable_Day`] 
| Value‐semantic repository of time‐indexed state transitions for one day.
|===


== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/SerialDateImpUtil.adoc[`SerialDateImpUtil`] 
| Alias for `PosixDateImpUtil` when proleptic dates are not enabled.
|===


== Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/bdexStreamIn-05.adoc[`bdexStreamIn`] 
| Load into `variable` the enum value read from `stream` using BDEX.
| xref:BloombergLP/bdlt/bdexStreamOut-05.adoc[`bdexStreamOut`] 
| Write the enum `value` to `stream` using BDEX.
| xref:BloombergLP/bdlt/hashAppend-07b.adoc[`hashAppend`] 
| `hashAppend` overloads
| xref:BloombergLP/bdlt/maxSupportedBdexVersion-0b.adoc[`maxSupportedBdexVersion`] 
| Return the maximum valid BDEX format version for this type.
| xref:BloombergLP/bdlt/operator_bitand.adoc[`operator&`] 
| Return a set containing the intersection of the specified `lhs` and `rhs` sets (i.e., a set containing elements that are in both `lhs` and `rhs`).
| xref:BloombergLP/bdlt/operator_plus-0a.adoc[`operator+`] 
| Addition operators
| xref:BloombergLP/bdlt/operator_inc-01.adoc[`operator++`] 
| Increment operators
| xref:BloombergLP/bdlt/operator_minus-02.adoc[`operator‐`] 
| Unary minus operators
| xref:BloombergLP/bdlt/operator_dec-0a.adoc[`operator‐‐`] 
| Decrement operators
| xref:BloombergLP/bdlt/operator_xor.adoc[`operatorˆ`] 
| Return a set containing the exclusive‐or of the specified `lhs` and `rhs` sets.
| xref:BloombergLP/bdlt/operator_bitor.adoc[`operator|`] 
| Return a set containing the union of the specified `lhs` and `rhs` sets (i.e., a set containing elements that are in either `lhs` or `rhs` or both).
| xref:BloombergLP/bdlt/operator_bitnot.adoc[`operator~`] 
| Return a set containing the complement of the specified `set` (i.e., those members _not_ contained in `set`).
| xref:BloombergLP/bdlt/swap-04.adoc[`swap`] 
| `swap` overloads
| xref:BloombergLP/bdlt/operator_lshift-0f.adoc[`operator<<`] 
| Stream insertion operators
| xref:BloombergLP/bdlt/operator_eq-07.adoc[`operator==`] 
| Equality operators
| xref:BloombergLP/bdlt/operator_not_eq-06c.adoc[`operator!=`] 
| Inequality operators
| xref:BloombergLP/bdlt/operator_lt-0c1.adoc[`operator<`] 
| Less‐than operators
| xref:BloombergLP/bdlt/operator_le-0c.adoc[`operator<=`] 
| Less‐than‐or‐equal operators
| xref:BloombergLP/bdlt/operator_gt-07.adoc[`operator>`] 
| Greater‐than operators
| xref:BloombergLP/bdlt/operator_ge-0e.adoc[`operator>=`] 
| Greater‐than‐or‐equal operators
|===



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