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

This class implements a test output stream for BDEX externalization.

== Synopsis

Declared in `<bslx_testoutstream.h>`

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

== Description

This class implements output methods to externalize fundamental types and their associated type identification data. It stores the accumulated result in network byte order. See the `bslx` package‐level documentation for the definition of the BDEX `OutStream` protocol.

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslx/TestOutStream/2constructor-0b.adoc[`TestOutStream`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bslx/TestOutStream/2destructor.adoc[`~TestOutStream`] [.small]#[destructor]#
| Destroy this object.
| xref:BloombergLP/bslx/TestOutStream/bdexVersionSelector.adoc[`bdexVersionSelector`] 
| Return the `versionSelector` to be used with `operator<<` for BDEX streaming as per the `bslx` package‐level documentation.
| xref:BloombergLP/bslx/TestOutStream/data.adoc[`data`] 
| Return the address of this stream's contiguous internal memory buffer.
| xref:BloombergLP/bslx/TestOutStream/invalidate.adoc[`invalidate`] 
| Put this output stream in an invalid state. This function has no effect if this stream is already invalid.
| xref:BloombergLP/bslx/TestOutStream/isValid.adoc[`isValid`] 
| Return `true` if this stream is valid, and `false` otherwise.
| xref:BloombergLP/bslx/TestOutStream/length.adoc[`length`] 
| Return the number of bytes in this stream.
| xref:BloombergLP/bslx/TestOutStream/makeNextInvalid.adoc[`makeNextInvalid`] 
| Make the next output operation emit the invalid data indicator.
| xref:BloombergLP/bslx/TestOutStream/putArrayFloat32.adoc[`putArrayFloat32`] 
| Write an array of single‐precision floating‐point values to this stream.
| xref:BloombergLP/bslx/TestOutStream/putArrayFloat64.adoc[`putArrayFloat64`] 
| Write an array of double‐precision floating‐point values to this stream.
| xref:BloombergLP/bslx/TestOutStream/putArrayInt16.adoc[`putArrayInt16`] 
| Write an array of two‐byte signed integers to this stream.
| xref:BloombergLP/bslx/TestOutStream/putArrayInt24.adoc[`putArrayInt24`] 
| Write an array of three‐byte signed integers to this stream.
| xref:BloombergLP/bslx/TestOutStream/putArrayInt32.adoc[`putArrayInt32`] 
| Write an array of four‐byte signed integers to this stream.
| xref:BloombergLP/bslx/TestOutStream/putArrayInt40.adoc[`putArrayInt40`] 
| Write an array of five‐byte signed integers to this stream.
| xref:BloombergLP/bslx/TestOutStream/putArrayInt48.adoc[`putArrayInt48`] 
| Write an array of six‐byte signed integers to this stream.
| xref:BloombergLP/bslx/TestOutStream/putArrayInt56.adoc[`putArrayInt56`] 
| Write an array of seven‐byte signed integers to this stream.
| xref:BloombergLP/bslx/TestOutStream/putArrayInt64.adoc[`putArrayInt64`] 
| Write an array of eight‐byte signed integers to this stream.
| xref:BloombergLP/bslx/TestOutStream/putArrayInt8-08.adoc[`putArrayInt8`] 
| Write an array of one‐byte signed integers to this stream.
| xref:BloombergLP/bslx/TestOutStream/putArrayUint16.adoc[`putArrayUint16`] 
| Write an array of two‐byte unsigned integers to this stream.
| xref:BloombergLP/bslx/TestOutStream/putArrayUint24.adoc[`putArrayUint24`] 
| Write an array of three‐byte unsigned integers to this stream.
| xref:BloombergLP/bslx/TestOutStream/putArrayUint32.adoc[`putArrayUint32`] 
| Write an array of four‐byte unsigned integers to this stream.
| xref:BloombergLP/bslx/TestOutStream/putArrayUint40.adoc[`putArrayUint40`] 
| Write an array of five‐byte unsigned integers to this stream.
| xref:BloombergLP/bslx/TestOutStream/putArrayUint48.adoc[`putArrayUint48`] 
| Write an array of six‐byte unsigned integers to this stream.
| xref:BloombergLP/bslx/TestOutStream/putArrayUint56.adoc[`putArrayUint56`] 
| Write an array of seven‐byte unsigned integers to this stream.
| xref:BloombergLP/bslx/TestOutStream/putArrayUint64.adoc[`putArrayUint64`] 
| Write an array of eight‐byte unsigned integers to this stream.
| xref:BloombergLP/bslx/TestOutStream/putArrayUint8-05.adoc[`putArrayUint8`] 
| Write an array of one‐byte unsigned integers to this stream.
| xref:BloombergLP/bslx/TestOutStream/putFloat32.adoc[`putFloat32`] 
| Write a single‐precision floating‐point value to this stream.
| xref:BloombergLP/bslx/TestOutStream/putFloat64.adoc[`putFloat64`] 
| Write a double‐precision floating‐point value to this stream.
| xref:BloombergLP/bslx/TestOutStream/putInt16.adoc[`putInt16`] 
| Write a two‐byte signed integer value to this stream.
| xref:BloombergLP/bslx/TestOutStream/putInt24.adoc[`putInt24`] 
| Write a three‐byte signed integer value to this stream.
| xref:BloombergLP/bslx/TestOutStream/putInt32.adoc[`putInt32`] 
| Write a four‐byte signed integer value to this stream.
| xref:BloombergLP/bslx/TestOutStream/putInt40.adoc[`putInt40`] 
| Write a five‐byte signed integer value to this stream.
| xref:BloombergLP/bslx/TestOutStream/putInt48.adoc[`putInt48`] 
| Write a six‐byte signed integer value to this stream.
| xref:BloombergLP/bslx/TestOutStream/putInt56.adoc[`putInt56`] 
| Write a seven‐byte signed integer value to this stream.
| xref:BloombergLP/bslx/TestOutStream/putInt64.adoc[`putInt64`] 
| Write an eight‐byte signed integer value to this stream.
| xref:BloombergLP/bslx/TestOutStream/putInt8.adoc[`putInt8`] 
| Write a one‐byte signed integer value to this stream.
| xref:BloombergLP/bslx/TestOutStream/putLength.adoc[`putLength`] 
| Write a BDEX length value to this stream.
| xref:BloombergLP/bslx/TestOutStream/putString.adoc[`putString`] 
| Write a string value to this stream.
| xref:BloombergLP/bslx/TestOutStream/putUint16.adoc[`putUint16`] 
| Write a two‐byte unsigned integer value to this stream.
| xref:BloombergLP/bslx/TestOutStream/putUint24.adoc[`putUint24`] 
| Write a three‐byte unsigned integer value to this stream.
| xref:BloombergLP/bslx/TestOutStream/putUint32.adoc[`putUint32`] 
| Write a four‐byte unsigned integer value to this stream.
| xref:BloombergLP/bslx/TestOutStream/putUint40.adoc[`putUint40`] 
| Write a five‐byte unsigned integer value to this stream.
| xref:BloombergLP/bslx/TestOutStream/putUint48.adoc[`putUint48`] 
| Write a six‐byte unsigned integer value to this stream.
| xref:BloombergLP/bslx/TestOutStream/putUint56.adoc[`putUint56`] 
| Write a seven‐byte unsigned integer value to this stream.
| xref:BloombergLP/bslx/TestOutStream/putUint64.adoc[`putUint64`] 
| Write an eight‐byte unsigned integer value to this stream.
| xref:BloombergLP/bslx/TestOutStream/putUint8.adoc[`putUint8`] 
| Write a one‐byte unsigned integer value to this stream.
| xref:BloombergLP/bslx/TestOutStream/putVersion.adoc[`putVersion`] 
| Write a BDEX version value to this stream.
| xref:BloombergLP/bslx/TestOutStream/reserveCapacity.adoc[`reserveCapacity`] 
| Set the internal buffer size of this stream to be at least the specified `newCapacity` (in bytes).
| xref:BloombergLP/bslx/TestOutStream/reset.adoc[`reset`] 
| Remove all content in this stream and validate this stream if it is currently invalid.
| xref:BloombergLP/bslx/TestOutStream/2conversion.adoc[`operator void const*`] 
| Return a non‐zero value if this stream is valid, and 0 otherwise.
|===


== Friends

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

== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslx/operator_lshift-09.adoc[`operator<<`]
| Write a BDEX‐compliant `value` to the specified test output `stream`.
|===


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