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

In‐core representation of an unsigned 16‐bit big‐endian integer.

== Synopsis

Declared in `<bdlb_bigendian.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class BigEndianUint16;
----

== Description

This class provides a container for an in‐core representation of an unsigned 16‐bit big‐endian integer. It supports a complete set of _value_ _semantic_ operations, including copy construction, assignment, equality comparison, `bsl::ostream` printing, and BDEX serialization. Note that the copy constructor and copy‐assignment operator are provided by the compiler. Any object of this class can be converted to an `unsigned short` allowing comparison with any other object of this class. This class is _exception_ _neutral_ with no guarantee of rollback: if an exception is thrown during the invocation of a method on a pre‐existing object, the object is left in a valid state, but its value is undefined. In no event is memory leaked. Finally, _aliasing_ (e.g., using all or part of an object as both source and destination) is supported in all cases.

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlb/BigEndianUint16/operator_assign.adoc[`operator=`] 
| Store in this object the specified `value` as an unsigned 16‐bit big‐endian integer, and return a reference to this modifiable object.
| xref:BloombergLP/bdlb/BigEndianUint16/bdexStreamIn.adoc[`bdexStreamIn`] 
| Assign to this object the value read from the specified input `stream`.
| xref:BloombergLP/bdlb/BigEndianUint16/bdexStreamOut.adoc[`bdexStreamOut`] 
| Write this value to the specified output `stream`.
| xref:BloombergLP/bdlb/BigEndianUint16/print.adoc[`print`] 
| Format this object to the specified output `stream`.
| xref:BloombergLP/bdlb/BigEndianUint16/2conversion-09.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration<BigEndianUint16, HasPrintMethod>`] 
| Declare that this type is trivially copyable.
| xref:BloombergLP/bdlb/BigEndianUint16/2conversion-0d.adoc[`operator unsigned short`] 
| Return the value stored in this object as a `unsigned short` in the native byte‐order.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlb/BigEndianUint16/make.adoc[`make`] 
| Create and initialize a `BigEndianUint16` object that stores the specified `value` as a unsigned 16‐bit big‐endian integer.
| xref:BloombergLP/bdlb/BigEndianUint16/maxSupportedBdexVersion-02.adoc[`maxSupportedBdexVersion`] 
| `maxSupportedBdexVersion` overloads
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bdlb/operator_not_eq-06e.adoc[BloombergLP::bdlb::operator!=]`
| Return `true` if the specified `lhs` and `rhs` do not have the same value.
| `xref:BloombergLP/bdlb/operator_eq-022e.adoc[BloombergLP::bdlb::operator==]`
| Return `true` if the specified `lhs` and `rhs` have the same value.
|===


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