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

This class provides input methods to unexternalize values, and C&hyphen;style arrays of values, of the fundamental integral and floating&hyphen;point types, as well as `bsl&colon;&colon;string` values, using a byte format documented in the `bslx&lowbar;byteoutstream` component&period; In particular, each `get` method of this class is guaranteed to read stream data written by the corresponding `put` method of `bslx&colon;&colon;ByteOutStream`&period; Note that attempting to read beyond the end of a stream will automatically invalidate the stream&period; See the `bslx` package&hyphen;level documentation for the definition of the BDEX `InStream` protocol&period;

== Synopsis

Declared in `&lt;bslx&lowbar;byteinstream&period;h&gt;`

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

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslx/ByteInStream/2constructor-08.adoc[`ByteInStream`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bslx/ByteInStream/2destructor.adoc[`&#126;ByteInStream`] [.small]#[destructor]#
| Destroy this object&period;
| xref:BloombergLP/bslx/ByteInStream/cursor.adoc[`cursor`] 
| Return the index of the next byte to be extracted from this stream&period;
| xref:BloombergLP/bslx/ByteInStream/data.adoc[`data`] 
| Return the address of the contiguous, non&hyphen;modifiable external memory buffer of this stream&period; The behavior of accessing elements outside the range `&lsqb; data() &period;&period; data() &plus; (length() &hyphen; 1) &rsqb;` is undefined&period;
| xref:BloombergLP/bslx/ByteInStream/getArrayFloat32.adoc[`getArrayFloat32`] 
| Assign to the specified `variables` the consecutive four&hyphen;byte IEEE single&hyphen;precision floating&hyphen;point numbers (in host byte order) comprised of each of the specified `numVariables` four&hyphen;byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variables` is undefined&period; The behavior is undefined unless `0 &lt;&equals; numVariables` and `variables` has sufficient capacity&period;
| xref:BloombergLP/bslx/ByteInStream/getArrayFloat64.adoc[`getArrayFloat64`] 
| Assign to the specified `variables` the consecutive eight&hyphen;byte IEEE double&hyphen;precision floating&hyphen;point numbers (in host byte order) comprised of each of the specified `numVariables` eight&hyphen;byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variables` is undefined&period; The behavior is undefined unless `0 &lt;&equals; numVariables` and `variables` has sufficient capacity&period;
| xref:BloombergLP/bslx/ByteInStream/getArrayInt16.adoc[`getArrayInt16`] 
| Assign to the specified `variables` the consecutive two&hyphen;byte, two&apos;s complement integers (in host byte order) comprised of each of the specified `numVariables` two&hyphen;byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variables` is undefined&period; The behavior is undefined unless `0 &lt;&equals; numVariables` and `variables` has sufficient capacity&period; Note that each of the values will be sign&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getArrayInt24.adoc[`getArrayInt24`] 
| Assign to the specified `variables` the consecutive three&hyphen;byte, two&apos;s complement integers (in host byte order) comprised of each of the specified `numVariables` three&hyphen;byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variables` is undefined&period; The behavior is undefined unless `0 &lt;&equals; numValues` and `variables` has sufficient capacity&period; Note that each of the values will be sign&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getArrayInt32.adoc[`getArrayInt32`] 
| Assign to the specified `variables` the consecutive four&hyphen;byte, two&apos;s complement integers (in host byte order) comprised of each of the specified `numVariables` four&hyphen;byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variables` is undefined&period; The behavior is undefined unless `0 &lt;&equals; numVariables` and `variables` has sufficient capacity&period; Note that each of the values will be sign&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getArrayInt40.adoc[`getArrayInt40`] 
| Assign to the specified `variables` the consecutive five&hyphen;byte, two&apos;s complement integers (in host byte order) comprised of each of the specified `numVariables` five&hyphen;byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variables` is undefined&period; The behavior is undefined unless `0 &lt;&equals; numVariables` and `variables` has sufficient capacity&period; Note that each of the values will be sign&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getArrayInt48.adoc[`getArrayInt48`] 
| Assign to the specified `variables` the consecutive six&hyphen;byte, two&apos;s complement integers (in host byte order) comprised of each of the specified `numVariables` six&hyphen;byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variables` is undefined&period; The behavior is undefined unless `0 &lt;&equals; numVariables` and `variables` has sufficient capacity&period; Note that each of the values will be sign&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getArrayInt56.adoc[`getArrayInt56`] 
| Assign to the specified `variables` the consecutive seven&hyphen;byte, two&apos;s complement integers (in host byte order) comprised of each of the specified `numVariables` seven&hyphen;byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variables` is undefined&period; The behavior is undefined unless `0 &lt;&equals; numVariables` and `variables` has sufficient capacity&period; Note that each of the values will be sign&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getArrayInt64.adoc[`getArrayInt64`] 
| Assign to the specified `variables` the consecutive eight&hyphen;byte, two&apos;s complement integers (in host byte order) comprised of each of the specified `numVariables` eight&hyphen;byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variables` is undefined&period; The behavior is undefined unless `0 &lt;&equals; numVariables` and `variables` has sufficient capacity&period; Note that each of the values will be sign&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getArrayInt8-03.adoc[`getArrayInt8`] 
| `getArrayInt8` overloads
| xref:BloombergLP/bslx/ByteInStream/getArrayUint16.adoc[`getArrayUint16`] 
| Assign to the specified `variables` the consecutive two&hyphen;byte, two&apos;s complement unsigned integers (in host byte order) comprised of each of the specified `numVariables` two&hyphen;byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variables` is undefined&period; The behavior is undefined unless `0 &lt;&equals; numVariables` and `variables` has sufficient capacity&period; Note that each of the values will be zero&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getArrayUint24.adoc[`getArrayUint24`] 
| Assign to the specified `variables` the consecutive three&hyphen;byte, two&apos;s complement unsigned integers (in host byte order) comprised of each of the specified `numVariables` three&hyphen;byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variables` is undefined&period; The behavior is undefined unless `0 &lt;&equals; numVariables` and `variables` has sufficient capacity&period; Note that each of the values will be zero&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getArrayUint32.adoc[`getArrayUint32`] 
| Assign to the specified `variables` the consecutive four&hyphen;byte, two&apos;s complement unsigned integers (in host byte order) comprised of each of the specified `numVariables` four&hyphen;byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variables` is undefined&period; The behavior is undefined unless `0 &lt;&equals; numVariables` and `variables` has sufficient capacity&period; Note that each of the values will be zero&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getArrayUint40.adoc[`getArrayUint40`] 
| Assign to the specified `variables` the consecutive five&hyphen;byte, two&apos;s complement unsigned integers (in host byte order) comprised of each of the specified `numVariables` five&hyphen;byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variables` is undefined&period; The behavior is undefined unless `0 &lt;&equals; numVariables` and `variables` has sufficient capacity&period; Note that each of the values will be zero&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getArrayUint48.adoc[`getArrayUint48`] 
| Assign to the specified `variables` the consecutive six&hyphen;byte, two&apos;s complement unsigned integers (in host byte order) comprised of each of the specified `numVariables` six&hyphen;byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variables` is undefined&period; The behavior is undefined unless `0 &lt;&equals; numVariables` and `variables` has sufficient capacity&period; Note that each of the values will be zero&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getArrayUint56.adoc[`getArrayUint56`] 
| Assign to the specified `variables` the consecutive seven&hyphen;byte, two&apos;s complement unsigned integers (in host byte order) comprised of each of the specified `numVariables` seven&hyphen;byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variables` is undefined&period; The behavior is undefined unless `0 &lt;&equals; numVariables` and `variables` has sufficient capacity&period; Note that each of the values will be zero&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getArrayUint64.adoc[`getArrayUint64`] 
| Assign to the specified `variables` the consecutive eight&hyphen;byte, two&apos;s complement unsigned integers (in host byte order) comprised of each of the specified `numVariables` eight&hyphen;byte sequences of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variables` is undefined&period; The behavior is undefined unless `0 &lt;&equals; numVariables` and `variables` has sufficient capacity&period; Note that each of the values will be zero&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getArrayUint8-09.adoc[`getArrayUint8`] 
| `getArrayUint8` overloads
| xref:BloombergLP/bslx/ByteInStream/getFloat32.adoc[`getFloat32`] 
| Assign to the specified `variable` the four&hyphen;byte IEEE single&hyphen;precision floating&hyphen;point number (in host byte order) comprised of the four bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variable` is undefined&period;
| xref:BloombergLP/bslx/ByteInStream/getFloat64.adoc[`getFloat64`] 
| Assign to the specified `variable` the eight&hyphen;byte IEEE double&hyphen;precision floating&hyphen;point number (in host byte order) comprised of the eight bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variable` is undefined&period;
| xref:BloombergLP/bslx/ByteInStream/getInt16.adoc[`getInt16`] 
| Assign to the specified `variable` the two&hyphen;byte, two&apos;s complement integer (in host byte order) comprised of the two bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variable` is undefined&period; Note that the value will be sign&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getInt24.adoc[`getInt24`] 
| Assign to the specified `variable` the three&hyphen;byte, two&apos;s complement integer (in host byte order) comprised of the three bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variable` is undefined&period; Note that the value will be sign&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getInt32.adoc[`getInt32`] 
| Assign to the specified `variable` the four&hyphen;byte, two&apos;s complement integer (in host byte order) comprised of the four bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variable` is undefined&period; Note that the value will be sign&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getInt40.adoc[`getInt40`] 
| Assign to the specified `variable` the five&hyphen;byte, two&apos;s complement integer (in host byte order) comprised of the five bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variable` is undefined&period; Note that the value will be sign&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getInt48.adoc[`getInt48`] 
| Assign to the specified `variable` the six&hyphen;byte, two&apos;s complement integer (in host byte order) comprised of the six bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variable` is undefined&period; Note that the value will be sign&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getInt56.adoc[`getInt56`] 
| Assign to the specified `variable` the seven&hyphen;byte, two&apos;s complement integer (in host byte order) comprised of the seven bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variable` is undefined&period; Note that the value will be sign&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getInt64.adoc[`getInt64`] 
| Assign to the specified `variable` the eight&hyphen;byte, two&apos;s complement integer (in host byte order) comprised of the eight bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variable` is undefined&period; Note that the value will be sign&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getInt8-0a.adoc[`getInt8`] 
| `getInt8` overloads
| xref:BloombergLP/bslx/ByteInStream/getLength.adoc[`getLength`] 
| If the most&hyphen;significant bit of the one byte of this stream at the current cursor location is set, assign to the specified `length` the four&hyphen;byte, two&apos;s complement integer (in host byte order) comprised of the four bytes of this stream at the current cursor location (in network byte order) with the most&hyphen;significant bit unset&semi; otherwise, assign to `length` the one&hyphen;byte, two&apos;s complement integer comprised of the one byte of this stream at the current cursor location&period; Update the cursor location and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `length` is undefined&period; Note that the value will be zero&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getString.adoc[`getString`] 
| Assign to the specified `variable` the string comprised of the length of the string (see `getLength`) and the string data (see `getUint8`), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variable` is undefined&period;
| xref:BloombergLP/bslx/ByteInStream/getUint16.adoc[`getUint16`] 
| Assign to the specified `variable` the two&hyphen;byte, two&apos;s complement unsigned integer (in host byte order) comprised of the two bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variable` is undefined&period; Note that the value will be zero&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getUint24.adoc[`getUint24`] 
| Assign to the specified `variable` the three&hyphen;byte, two&apos;s complement unsigned integer (in host byte order) comprised of the three bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variable` is undefined&period; Note that the value will be zero&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getUint32.adoc[`getUint32`] 
| Assign to the specified `variable` the four&hyphen;byte, two&apos;s complement unsigned integer (in host byte order) comprised of the four bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variable` is undefined&period; Note that the value will be zero&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getUint40.adoc[`getUint40`] 
| Assign to the specified `variable` the five&hyphen;byte, two&apos;s complement unsigned integer (in host byte order) comprised of the five bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variable` is undefined&period; Note that the value will be zero&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getUint48.adoc[`getUint48`] 
| Assign to the specified `variable` the six&hyphen;byte, two&apos;s complement unsigned integer (in host byte order) comprised of the six bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variable` is undefined&period; Note that the value will be zero&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getUint56.adoc[`getUint56`] 
| Assign to the specified `variable` the seven&hyphen;byte, two&apos;s complement unsigned integer (in host byte order) comprised of the seven bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variable` is undefined&period; Note that the value will be zero&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getUint64.adoc[`getUint64`] 
| Assign to the specified `variable` the eight&hyphen;byte, two&apos;s complement unsigned integer (in host byte order) comprised of the eight bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variable` is undefined&period; Note that the value will be zero&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/getUint8-05.adoc[`getUint8`] 
| `getUint8` overloads
| xref:BloombergLP/bslx/ByteInStream/getVersion.adoc[`getVersion`] 
| Assign to the specified `version` the one&hyphen;byte, two&apos;s complement unsigned integer comprised of the one byte of this stream at the current cursor location, update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `version` is undefined&period; Note that the value will be zero&hyphen;extended&period;
| xref:BloombergLP/bslx/ByteInStream/invalidate.adoc[`invalidate`] 
| Put this input stream in an invalid state&period; This function has no effect if this stream is already invalid&period; Note that this function should be called whenever a value extracted from this stream is determined to be invalid, inconsistent, or otherwise incorrect&period;
| xref:BloombergLP/bslx/ByteInStream/isEmpty.adoc[`isEmpty`] 
| Return `true` if this stream is empty, and `false` otherwise&period; Note that this function enables higher&hyphen;level types to verify that, after successfully reading all expected data, no data remains&period;
| xref:BloombergLP/bslx/ByteInStream/isValid.adoc[`isValid`] 
| Return `true` if this stream is valid, and `false` otherwise&period; An invalid stream is a stream in which insufficient or invalid data was detected during an extraction operation&period; Note that an empty stream will be valid unless an extraction attempt or explicit invalidation causes it to be otherwise&period;
| xref:BloombergLP/bslx/ByteInStream/length.adoc[`length`] 
| Return the total number of bytes stored in the external memory buffer&period;
| xref:BloombergLP/bslx/ByteInStream/reset-04.adoc[`reset`] 
| `reset` overloads
| xref:BloombergLP/bslx/ByteInStream/2conversion.adoc[`operator void const*`] 
| Return a non&hyphen;zero value if this stream is valid, and 0 otherwise&period; An invalid stream is a stream for which an input operation was detected to have failed&period;
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bslx/operator_lshift-0ae.adoc[BloombergLP::bslx::operator&lt;&lt;]`
| Write the specified `object` to the specified output `stream` in some reasonable (multi&hyphen;line) format, and return a reference to `stream`&period;
|===

== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslx/operator_rshift-038.adoc[`operator&gt;&gt;`]
| Read the specified `value` from the specified input `stream` following the requirements of the BDEX protocol (see the `bslx` package&hyphen;level documentation), and return a reference to `stream`&period; The behavior is undefined unless `TYPE` is BDEX&hyphen;compliant&period;
|===


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