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

This component‐private `struct` provides a namespace for a suite of functions used by `BerUtil` to implement BER encoding and decoding operations for date values. Within the definition of this `struct`:

== Synopsis

Declared in `<balber_berutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct BerUtil_DateImpUtil;
----

== Description

* *the specification*: > Refers to the August 2015 revision of the ITU‐T Recommendation X.690.

* *the default set of options*: > Refers to a `balber::BerEncoderOptions` value having a > `datetimeFractionalSecondPrecision` attribute of 3 and a > `encodeDateAndTimeTypesAsBinary` attribute of `false`.

See the package level documentation of `balber` for a definition of the compact and extended binary formats for date and time values.

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balber/BerUtil_DateImpUtil/DateAndTimeHeaderUtil.adoc[`DateAndTimeHeaderUtil`] 
| `DateAndTimeHeaderUtil` is an alias to a namespace for a suite of functions used to implement encoding and decoding operations for the 2‐byte header of an extended‐binary‐encoding formatted date‐and‐time value.
| xref:BloombergLP/balber/BerUtil_DateImpUtil/DateEncoding.adoc[`DateEncoding`] 
| `DateEncoding` is an alias to a namespace for enumerating the set of formats that may be used by `BerUtil` to encode and decode values of `bdlt::Date` type.
| xref:BloombergLP/balber/BerUtil_DateImpUtil/DateOrDateTz.adoc[`DateOrDateTz`] 
| `DateOrDateTz` is a convenient alias for `bdlb::Variant2<bdlt::Date, bdlt::DateTz>`.
| xref:BloombergLP/balber/BerUtil_DateImpUtil/DateOrDateTzEncoding.adoc[`DateOrDateTzEncoding`] 
| `DateEncoding` is an alias to a namespace for enumerating the set of formats that may be used by `BerUtil` to decode to values of `bdlb::Variant2<bdlt::Date, bdlt::DateTz>` type.
| xref:BloombergLP/balber/BerUtil_DateImpUtil/DateTzEncoding.adoc[`DateTzEncoding`] 
| `DateEncoding` is an alias to a namespace for enumerating the set of formats that may be used by `BerUtil` to encode and decode values of `bdlt::DateTz` type.
| xref:BloombergLP/balber/BerUtil_DateImpUtil/IntegerUtil.adoc[`IntegerUtil`] 
| `IntegerUtil` is an alias to a namespace for a suite of functions used to implement BER encoding and decoding operations for integer values.
| xref:BloombergLP/balber/BerUtil_DateImpUtil/Iso8601Util.adoc[`Iso8601Util`] 
| `Iso8601Util` is an alias to a namespace for a suite of functions used to implementing the encoding and decoding of date and time values using the ISO 8601 format.
| xref:BloombergLP/balber/BerUtil_DateImpUtil/LengthUtil.adoc[`LengthUtil`] 
| `LengthUtil` is an alias to a namespace for a suite of functions used to implement BER encoding and decoding operations for length quantities.
| xref:BloombergLP/balber/BerUtil_DateImpUtil/StreambufUtil.adoc[`StreambufUtil`] 
| `StreambufUtil` is an alias to a namespace for a suite of functions used to implement input and output operations on `bsl::streambuf` objects.
| xref:BloombergLP/balber/BerUtil_DateImpUtil/StringUtil.adoc[`StringUtil`] 
| `StringUtil` is an alias to a namespace for a suite of functions used by `BerUtil` to implement BER encoding and decoding operations for string values.
| xref:BloombergLP/balber/BerUtil_DateImpUtil/TimezoneUtil.adoc[`TimezoneUtil`] 
| `TimezoneUtil` is an alias to a namespace for a suite of functions used to implement BER encoding and decoding operations for time‐zone offset values.
|===


== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balber/BerUtil_DateImpUtil/_04enum.adoc[`Unnamed enum`] 
| Constants used when encoding dates in compact binary format.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balber/BerUtil_DateImpUtil/dateToDaysSinceEpoch.adoc[`dateToDaysSinceEpoch`] 
| Load to the specified `daysSinceEpoch` the number of days between the compact‐binary date epoch and the specified `date`. The compact‐binary date epoch is the date defined by the `k_COMPACT_BINARY_DATE_EPOCH` serial date. Note that this quantity may be negative if the specified `date` occurs before the compact‐binary date epoch.
| xref:BloombergLP/balber/BerUtil_DateImpUtil/daysSinceEpochToDate.adoc[`daysSinceEpochToDate`] 
| Load to the specified `date` the date represented by the serial date indicated by adding the specified `daysSinceEpoch` to `k_COMPACT_BINARY_DATE_EPOCH`. Return 0 on success, and a non‐zero value otherwise. This operation succeeds if the resulting value represents a date in the range `[0001JAN01 .. 9999DEC31]`. Note that `daysSinceEpoch` may be negative to indicate a serial date that occurs before `k_COMPACT_BINARY_DATE_EPOCH`.
| xref:BloombergLP/balber/BerUtil_DateImpUtil/getDateOrDateTzValue.adoc[`getDateOrDateTzValue`] 
| Read the specified `length` number of bytes from the input sequence of the specified `streamBuf` and load to the specified `value` the date and optional time zone value represented by those bytes. Return 0 on success, and a non‐zero value otherwise. The operation succeeds if `length` bytes are successfully read from the input sequence of the `streamBuf` without the read position becoming unavailable, and the bytes contain a valid representation of a date and optional time zone value. See the package‐level documentation of {`balber`} for a description of the decision procedure used to detect the encoding format for a `DateOrDateTz` value.
| xref:BloombergLP/balber/BerUtil_DateImpUtil/getDateTzValue.adoc[`getDateTzValue`] 
| Read the specified `length` number of bytes from the input sequence of the specified `streamBuf` and load to the specified `value` the date and time zone value represented by those bytes. Return 0 on success, and a non‐zero value otherwise. The operation succeeds if `length` bytes are successfully read from the input sequence of the `streamBuf` without the read position becoming unavailable, and the bytes contain a valid representation of a date and time zone value. See the package‐level documentation of {`balber`} for a description of the decision procedure used to detect the encoding format for a `bdlt::DateTz` value.
| xref:BloombergLP/balber/BerUtil_DateImpUtil/getDateValue.adoc[`getDateValue`] 
| Read the specified `length` number of bytes from the input sequence of the specified `streamBuf` and load to the specified `value` the date value represented those bytes. Return 0 on success, and a non‐zero value otherwise. The operation succeeds if `length` bytes are successfully read from the input sequence of the `streamBuf` without the read position becoming unavailable, and the bytes contain a valid representation of a date value. See the package‐level documentation of {`balber`} for a description of the decision procedure used to detect the encoding format for a `bdlt::Date` value.
| xref:BloombergLP/balber/BerUtil_DateImpUtil/putDateTzValue.adoc[`putDateTzValue`] 
| Write a representation of the specified `value` date and time zone to the output sequence of the specified `streamBuf` according to the specified `options`. If `options` is 0, the default set of options is used. Return 0 on success, and a non‐zero value otherwise. This operation succeeds if all bytes in the representation of the `value` are written to the output sequence of the `streamBuf` without the write position becoming unavailable. See the class documentation for a description of the default options. See the package‐level documentation of {`balber`} for a description of the decision procedure used to select an encoding format for the `value`.
| xref:BloombergLP/balber/BerUtil_DateImpUtil/putDateValue.adoc[`putDateValue`] 
| Write a representation of the specified `value` date to the output sequence of the specified `streamBuf` according to the specified `options`. If `options` is 0, the default set of options is used. Return 0 on success, and a non‐zero value otherwise. This operation succeeds if all bytes in the representation of the `value` are written to the output sequence of the `streamBuf` without the write position becoming unavailable. See the class documentation for a description of the default options. See the package‐level documentation of {`balber`} for a description of the decision procedure used to select an encoding format for the `value`.
|===



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