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

Package namespace for BER encoding and decoding components.

== Types

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balber/BerConstants.adoc[`BerConstants`] 
| This `struct` contains enumerations of the constants used by the BER encoder and decoder.
| xref:BloombergLP/balber/BerDecoder.adoc[`BerDecoder`] 
| This class contains the parameterized `decode` functions that decode data (in BER format) from an incoming stream into `bdlat` types.
| xref:BloombergLP/balber/BerDecoderOptions.adoc[`BerDecoderOptions`] 
| BER decoding options
| xref:BloombergLP/balber/BerDecoder_Node.adoc[`BerDecoder_Node`] 
| This class provides current context for BER decoding process and represents a node for BER element. The BER element consists of element tag, length field, body field and optional end of tag. The class also provides various methods to read the different parts of BER element such as tag header (tag itself and length fields), body for any type of data, and optional tag trailer.
| xref:BloombergLP/balber/BerDecoder_NodeVisitor.adoc[`BerDecoder_NodeVisitor`] 
| This class is used as a visitor for visiting contained objects during decoding.
| xref:BloombergLP/balber/BerDecoder_UniversalElementVisitor.adoc[`BerDecoder_UniversalElementVisitor`] 
| This `class` is used as a visitor for visiting the top‐level element and also array elements during decoding. This class is required so that the universal tag number of the element can be determined when the element is visited.
| xref:BloombergLP/balber/BerDecoder_Zeroer.adoc[`BerDecoder_Zeroer`] 
| This class is a deleter that just zeroes out a given pointer upon destruction, for making code exception‐safe.
| xref:BloombergLP/balber/BerEncoder.adoc[`BerEncoder`] 
| This class contains the parameterized `encode` functions that encode `bdlat` types to an outgoing stream in BER format.
| xref:BloombergLP/balber/BerEncoderOptions.adoc[`BerEncoderOptions`] 
| Forward declaration of `BerEncoderOptions`.
| xref:BloombergLP/balber/BerEncoderOptionsUtil.adoc[`BerEncoderOptionsUtil`] 
| This `struct` provides a namespace for functions that set `BerEncoderOptions` to particular configurations.
| xref:BloombergLP/balber/BerEncoder_LevelGuard.adoc[`BerEncoder_LevelGuard`] 
| This class serves the purpose to automatically increment‐decrement the current depth level.
| xref:BloombergLP/balber/BerEncoder_UniversalElementVisitor.adoc[`BerEncoder_UniversalElementVisitor`] 
| This class is used as a visitor for visiting the top‐level element and also array elements during encoding. This class is required so that the universal tag number of the element can be determined when the element is visited.
| xref:BloombergLP/balber/BerEncoder_UseArrayLengthHintGuard.adoc[`BerEncoder_UseArrayLengthHintGuard`] 
| This class serves the purpose to set and reset the value of `d_useArrayLengthHint`.
| xref:BloombergLP/balber/BerEncoder_Visitor.adoc[`BerEncoder_Visitor`] 
| This class is used as a visitor for visiting contained objects during encoding. Produces always BER elements with CONTEXT_SPECIFIC BER tag.
| xref:BloombergLP/balber/BerEncoder_encodeProxy.adoc[`BerEncoder_encodeProxy`] 
| Component‐private struct. Provides accessor that keeps current context and can be used in different `bdlat` Category Functions.
| xref:BloombergLP/balber/BerUniversalTagNumber.adoc[`BerUniversalTagNumber`] 
| This `struct` contains an enumeration of the universal tag numbers for BER encoding.
| xref:BloombergLP/balber/BerUniversalTagNumber_Sel.adoc[`BerUniversalTagNumber_Sel`] 
| Component‐private class. Do not use. This class contains implementation details of this component.
| xref:BloombergLP/balber/BerUtil.adoc[`BerUtil`] 
| This utility contains functions to encode and decode primitive BER constructs and simple value semantic types. By convention, all functions return 0 on success, and a non‐zero value otherwise. Also by convention, all the "get" functions take an `accumNumBytesConsumed`; each of the functions will add to this variable the number of bytes consumed within the scope of the function.
| xref:BloombergLP/balber/BerUtil_BooleanImpUtil.adoc[`BerUtil_BooleanImpUtil`] 
| This component‐private utility `struct` provides a namespace for a suite of functions used by `BerUtil` to implement BER encoding and decoding operations for boolean values. Within the definition of this `struct`:
| xref:BloombergLP/balber/BerUtil_CharacterImpUtil.adoc[`BerUtil_CharacterImpUtil`] 
| This component‐private utility `struct` provides a namespace for a suite of functions used by `BerUtil` to implement BER encoding and decoding operations for byte values. Within the definition of this `struct`:
| xref:BloombergLP/balber/BerUtil_Constants.adoc[`BerUtil_Constants`] 
| This component‐private utility `struct` provides a namespace for a set of constants used to calculate quantities needed by BER encoders and decoders. For example, this struct provides a named constant for the number of bits in a byte, which is used in downstream calculations.
| xref:BloombergLP/balber/BerUtil_DateAndTimeEncoding.adoc[`BerUtil_DateAndTimeEncoding`] 
| This component‐private `struct` provides a namespace for enumerating the union of the sets of date and time formats used to encode and decode all date and time types supported by `BerUtil`.
| xref:BloombergLP/balber/BerUtil_DateAndTimeHeader.adoc[`BerUtil_DateAndTimeHeader`] 
| This component‐private, in‐core, value‐semantic attribute class provides a representation of the information available in the first two bytes of any extended‐binary‐encoding formatted data. All extended‐binary encoding schemes for date‐and‐time types contain a 2‐byte header in the same format, which can be unambiguously distinguished from the first 2 bytes of a date‐and‐time type in its corresponding compact‐binary‐encoding format or its ISO 8601 format.
| xref:BloombergLP/balber/BerUtil_DateAndTimeHeaderImpUtil.adoc[`BerUtil_DateAndTimeHeaderImpUtil`] 
| This component‐private utility `struct` provides a namespace for a suite of functions used by `BerUtil` to implement encoding and decoding operations for the 2‐byte header of extended‐binary‐encoding formatted date‐and‐time value.
| xref:BloombergLP/balber/BerUtil_DateAndTimeHeaderType.adoc[`BerUtil_DateAndTimeHeaderType`] 
| This component‐private `struct` provides a namespace for enumerating the set of "header type" values that may be encoded in the 2‐byte header of an extended‐binary‐encoding formatted date‐and‐time value.
| xref:BloombergLP/balber/BerUtil_DateEncoding.adoc[`BerUtil_DateEncoding`] 
| This component‐private `struct` provides 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.adoc[`BerUtil_DateImpUtil`] 
| 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`:
| xref:BloombergLP/balber/BerUtil_DateOrDateTzEncoding.adoc[`BerUtil_DateOrDateTzEncoding`] 
| This component‐private `struct` provides a namespace for enumerating the set of formats that may be used by `BerUtil` to encode and decode values of `bdlb::Variant2<bdlt::Date, bdlt::DateTz>` type.
| xref:BloombergLP/balber/BerUtil_DateTzEncoding.adoc[`BerUtil_DateTzEncoding`] 
| This component‐private `struct` provides 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_DatetimeEncoding.adoc[`BerUtil_DatetimeEncoding`] 
| This component‐private utility `struct` provides a namespace for enumerating the set of formats that may be used by `BerUtil` to encode and decode values of `bdlt::Datetime` type.
| xref:BloombergLP/balber/BerUtil_DatetimeImpUtil.adoc[`BerUtil_DatetimeImpUtil`] 
| This component‐private `struct` provides a namespace for a suite of functions used by `BerUtil` to implement BER encoding and decoding operations for date and time values. Within the definition of this `struct`:
| xref:BloombergLP/balber/BerUtil_DatetimeOrDatetimeTzEncoding.adoc[`BerUtil_DatetimeOrDatetimeTzEncoding`] 
| This component‐private utility `struct` provides a namespace for enumerating the set of formats that may be used by `BerUtil` to decode to values of `bdlb::Variant2<bdlt::Datetime, bdlt::DatetimeTz>` type.
| xref:BloombergLP/balber/BerUtil_DatetimeTzEncoding.adoc[`BerUtil_DatetimeTzEncoding`] 
| This component‐private utility `struct` provides a namespace for enumerating the set of formats that may be used by `BerUtil` to encode and decode values of `bdlt::DatetimeTz` type.
| xref:BloombergLP/balber/BerUtil_ExtendedBinaryEncodingUtil.adoc[`BerUtil_ExtendedBinaryEncodingUtil`] 
| This component‐private utility `struct` provides a namespace for a suite of functions used by `BerUtil` to determine if a particular date and/or time value should be encoded using its corresponding extended‐binary‐encoding format, its corresponding compact‐binary‐encoding format, or neither format.
| xref:BloombergLP/balber/BerUtil_FloatingPointImpUtil.adoc[`BerUtil_FloatingPointImpUtil`] 
| This component‐private utility `struct` provides a namespace for a suite of functions used by `BerUtil` to implement BER encoding and decoding operations for floating point number values. Within the definition of this `struct`:
| xref:BloombergLP/balber/BerUtil_GetValueImpUtil.adoc[`BerUtil_GetValueImpUtil`] 
| This component‐private utility `struct` provides a namespace for a suite of functions that define the overload set for the implementation of `balber::BerUtil::getValue`. The set of types used for the `value` parameters in the overload set of `getValue` in this `struct` define the set of types that `balber::BerUtil::getValue` supports.
| xref:BloombergLP/balber/BerUtil_IdentifierImpUtil.adoc[`BerUtil_IdentifierImpUtil`] 
| This component‐private utility `struct` provides a namespace for a suite of functions used by `BerUtil` to implement BER identifier octet encoding and decoding.
| xref:BloombergLP/balber/BerUtil_IntegerImpUtil.adoc[`BerUtil_IntegerImpUtil`] 
| This component‐private utility `struct` provides a namespace for a suite of functions used by `BerUtil` to implement BER encoding and decoding operations for integer values. Within the definition of this `struct`:
| xref:BloombergLP/balber/BerUtil_Iso8601ImpUtil.adoc[`BerUtil_Iso8601ImpUtil`] 
| This component‐private utility `struct` provides a namespace for a suite of functions used by `BerUtil` to implement BER encoding and decoding operations for date and time values in the ISO 8601 format. See the component‐level documentation of {`bdlt_iso8601util`} for a complete description of the ISO 8601 format used by the functions provided by this `struct`.
| xref:BloombergLP/balber/BerUtil_LengthImpUtil.adoc[`BerUtil_LengthImpUtil`] 
| This component‐private utility `struct` provides a namespace for a suite of functions used by `BerUtil` to implement BER length quantity encoding and decoding.
| xref:BloombergLP/balber/BerUtil_PutValueImpUtil.adoc[`BerUtil_PutValueImpUtil`] 
| This component‐private utility `struct` provides a namespace for a suite of functions that define the overload set for the implementation of `balber::BerUtil::putValue`. The set of types used for the `value` parameters in the overload set of `putValue` in this `struct` define the set of types that `balber::BerUtil::putValue` supports.
| xref:BloombergLP/balber/BerUtil_RawIntegerImpUtil.adoc[`BerUtil_RawIntegerImpUtil`] 
| This component‐private utility `struct` provides a namespace for a suite of functions used by `BerUtil` to implement BER integer encoding. This `struct` is separate from `BerUtil_IntegerImpUtil` to break a dependency cycle between `BerUtil_IntegerImpUtil` and `BerUtil_LengthImpUtil`.
| xref:BloombergLP/balber/BerUtil_StreambufUtil.adoc[`BerUtil_StreambufUtil`] 
| This component‐private utility `struct` provides a namespace for a suite of functions used by `BerUtil` to perform input and output operations on `bsl::streambuf` objects. Note that these functions are intended to adapt the standard stream‐buffer operations to a BDE‐style interface.
| xref:BloombergLP/balber/BerUtil_StringImpUtil.adoc[`BerUtil_StringImpUtil`] 
| This component‐private utility `struct` provides a namespace for a suite of functions used by `BerUtil` to implement BER encoding and decoding operations for string values. Within the definition of this `struct`:
| xref:BloombergLP/balber/BerUtil_TimeEncoding.adoc[`BerUtil_TimeEncoding`] 
| This component‐private utility `struct` provides 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.adoc[`BerUtil_TimeImpUtil`] 
| 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`:
| xref:BloombergLP/balber/BerUtil_TimeOrTimeTzEncoding.adoc[`BerUtil_TimeOrTimeTzEncoding`] 
| This component‐private utility `struct` provides a namespace for enumerating the set of formats that may be used by `BerUtil` to decode values of `bdlb::Variant2<bdlt::Time, bdlt::TimeTz>` type.
| xref:BloombergLP/balber/BerUtil_TimeTzEncoding.adoc[`BerUtil_TimeTzEncoding`] 
| This component‐private utility `struct` provides 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_TimezoneOffsetImpUtil.adoc[`BerUtil_TimezoneOffsetImpUtil`] 
| This component‐private utility `struct` provides a namespace for a suite of functions and constants used by `BerUtil` to encode and decode time‐zone values.
|===


== Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balber/operator_lshift-09c.adoc[`operator<<`] 
| Stream insertion operators
| xref:BloombergLP/balber/operator_eq-061.adoc[`operator==`] 
| Equality operators
| xref:BloombergLP/balber/operator_not_eq-01.adoc[`operator!=`] 
| Inequality operators
|===



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