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

Utilities for BER time encoding and decoding.

== Synopsis

Declared in `<balber_berutil.h>`

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

== Description

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

* *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_TimeImpUtil/DateAndTimeHeader.adoc[`DateAndTimeHeader`] 
| Alias for the extended‐binary date‐and‐time header class.
| xref:BloombergLP/balber/BerUtil_TimeImpUtil/DateAndTimeHeaderType.adoc[`DateAndTimeHeaderType`] 
| Alias for the extended‐binary header type enumeration.
| xref:BloombergLP/balber/BerUtil_TimeImpUtil/DateAndTimeHeaderUtil.adoc[`DateAndTimeHeaderUtil`] 
| Alias for extended‐binary date‐and‐time header utilities.
| xref:BloombergLP/balber/BerUtil_TimeImpUtil/ExtendedBinaryEncodingUtil.adoc[`ExtendedBinaryEncodingUtil`] 
| Alias for extended‐binary encoding decision utilities.
| xref:BloombergLP/balber/BerUtil_TimeImpUtil/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_TimeImpUtil/Iso8601Util.adoc[`Iso8601Util`] 
| Alias for ISO 8601 date and time encoding utilities.
| xref:BloombergLP/balber/BerUtil_TimeImpUtil/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_TimeImpUtil/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_TimeImpUtil/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_TimeImpUtil/TimeEncoding.adoc[`TimeEncoding`] 
| `TimeEncoding` 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::Time` type.
| xref:BloombergLP/balber/BerUtil_TimeImpUtil/TimeOrTimeTz.adoc[`TimeOrTimeTz`] 
| `TimeOrTimeTz` is a convenient alias for `bdlb::Variant2<bdlt::Time, bdlt::TimeTz>`.
| xref:BloombergLP/balber/BerUtil_TimeImpUtil/TimeOrTimeTzEncoding.adoc[`TimeOrTimeTzEncoding`] 
| Alias for time‐or‐time‐tz encoding format enumerations.
| xref:BloombergLP/balber/BerUtil_TimeImpUtil/TimeTzEncoding.adoc[`TimeTzEncoding`] 
| `TimeTzEncoding` 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::TimeTz` type.
| xref:BloombergLP/balber/BerUtil_TimeImpUtil/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.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balber/BerUtil_TimeImpUtil/getTimeOrTimeTzValue.adoc[`getTimeOrTimeTzValue`] 
| Read the specified `length` number of bytes from the input sequence of the specified `streamBuf` and load to the specified `value` the time and optional time.
| xref:BloombergLP/balber/BerUtil_TimeImpUtil/getTimeTzValue.adoc[`getTimeTzValue`] 
| Read the specified `length` number of bytes from the input sequence of the specified `streamBuf` and load to the specified `value` the time and time zone value.
| xref:BloombergLP/balber/BerUtil_TimeImpUtil/getTimeValue.adoc[`getTimeValue`] 
| Read the specified `length` number of bytes from the input sequence of the specified `streamBuf` and load to the specified `value` the time value represented.
| xref:BloombergLP/balber/BerUtil_TimeImpUtil/microsecondsSinceMidnightToTime.adoc[`microsecondsSinceMidnightToTime`] 
| Load to the specified `time` the time value represented by the specified `microsecondsSinceMidnight`.
| xref:BloombergLP/balber/BerUtil_TimeImpUtil/millisecondsSinceMidnightToTime.adoc[`millisecondsSinceMidnightToTime`] 
| Load to the specified `time` the time value represented by the specified `millisecondsSinceMidnight`.
| xref:BloombergLP/balber/BerUtil_TimeImpUtil/putTimeTzValue.adoc[`putTimeTzValue`] 
| Write a representation of the specified time and time‐zone `value` to the output sequence of the specified `streamBuf` according to the specified `options`.
| xref:BloombergLP/balber/BerUtil_TimeImpUtil/putTimeValue.adoc[`putTimeValue`] 
| Write a representation of the specified time `value` to the output sequence of the specified `streamBuf` according to the specified `options`.
| xref:BloombergLP/balber/BerUtil_TimeImpUtil/timeToMicrosecondsSinceMidnight.adoc[`timeToMicrosecondsSinceMidnight`] 
| Load to the specified `microsecondsSinceMidnight` the number of microseconds in the specified `time` value.
| xref:BloombergLP/balber/BerUtil_TimeImpUtil/timeToMillisecondsSinceMidnight.adoc[`timeToMillisecondsSinceMidnight`] 
| Load to the specified `millisecondsSinceMidnight` the number of milliseconds in the specified `time` value.
|===



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