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

Provide utilities for marshalling fundamental types in network byte order.

== Synopsis

Declared in `<bslx_marshallingutil.h>`

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

== Description

This `struct` provides a namespace for a suite of functions that facilitate the marshalling of values, and C‐style arrays of values, of the fundamental integral and floating‐point types in a data‐independent, platform‐neutral representation.

== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslx/MarshallingUtil/_04enum.adoc[`Unnamed enum`] 
| Platform‐independent wire‐format sizes (in bytes) for marshalled types. Note that the wire‐format size may differ from the size in memory.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslx/MarshallingUtil/getArrayFloat32.adoc[`getArrayFloat32`] 
| Load consecutive four‐byte IEEE floats from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getArrayFloat64.adoc[`getArrayFloat64`] 
| Load consecutive eight‐byte IEEE doubles from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getArrayInt16.adoc[`getArrayInt16`] 
| Load consecutive two‐byte integers from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getArrayInt24.adoc[`getArrayInt24`] 
| Load consecutive three‐byte integers from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getArrayInt32.adoc[`getArrayInt32`] 
| Load consecutive four‐byte integers from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getArrayInt40.adoc[`getArrayInt40`] 
| Load 40‐bit integers from `buffer` into `variables`.
| xref:BloombergLP/bslx/MarshallingUtil/getArrayInt48.adoc[`getArrayInt48`] 
| Load consecutive six‐byte integers from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getArrayInt56.adoc[`getArrayInt56`] 
| Load consecutive seven‐byte integers from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getArrayInt64.adoc[`getArrayInt64`] 
| Load consecutive eight‐byte integers from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getArrayInt8-057.adoc[`getArrayInt8`] 
| `getArrayInt8` overloads
| xref:BloombergLP/bslx/MarshallingUtil/getArrayUint16.adoc[`getArrayUint16`] 
| Load consecutive two‐byte unsigned integers from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getArrayUint24.adoc[`getArrayUint24`] 
| Load consecutive three‐byte unsigned integers from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getArrayUint32.adoc[`getArrayUint32`] 
| Load `numVariables` big‐endian `uint32` values from `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getArrayUint40.adoc[`getArrayUint40`] 
| Load consecutive five‐byte unsigned integers from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getArrayUint48.adoc[`getArrayUint48`] 
| Load consecutive six‐byte unsigned integers from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getArrayUint56.adoc[`getArrayUint56`] 
| Load consecutive seven‐byte unsigned integers from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getArrayUint64.adoc[`getArrayUint64`] 
| Load consecutive eight‐byte unsigned integers from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getFloat32.adoc[`getFloat32`] 
| Load a four‐byte IEEE float from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getFloat64.adoc[`getFloat64`] 
| Load an eight‐byte IEEE double from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getInt16.adoc[`getInt16`] 
| Load a two‐byte integer from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getInt24.adoc[`getInt24`] 
| Load a three‐byte integer from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getInt32.adoc[`getInt32`] 
| Load a four‐byte integer from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getInt40.adoc[`getInt40`] 
| Load a five‐byte two's complement integer from `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getInt48.adoc[`getInt48`] 
| Load a six‐byte integer from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getInt56.adoc[`getInt56`] 
| Load a seven‐byte integer from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getInt64.adoc[`getInt64`] 
| Load an eight‐byte integer from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getInt8-03.adoc[`getInt8`] 
| `getInt8` overloads
| xref:BloombergLP/bslx/MarshallingUtil/getUint16.adoc[`getUint16`] 
| Load a two‐byte unsigned integer from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getUint24.adoc[`getUint24`] 
| Load a three‐byte unsigned integer from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getUint32.adoc[`getUint32`] 
| Load a four‐byte unsigned integer from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getUint40.adoc[`getUint40`] 
| Load a five‐byte unsigned integer from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getUint48.adoc[`getUint48`] 
| Load a six‐byte unsigned integer from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getUint56.adoc[`getUint56`] 
| Load a seven‐byte unsigned integer from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/getUint64.adoc[`getUint64`] 
| Load an eight‐byte unsigned integer from the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/putArrayFloat32.adoc[`putArrayFloat32`] 
| Store consecutive four‐byte IEEE floats into the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/putArrayFloat64.adoc[`putArrayFloat64`] 
| Store consecutive eight‐byte IEEE doubles into the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/putArrayInt16-02.adoc[`putArrayInt16`] 
| `putArrayInt16` overloads
| xref:BloombergLP/bslx/MarshallingUtil/putArrayInt24-07.adoc[`putArrayInt24`] 
| `putArrayInt24` overloads
| xref:BloombergLP/bslx/MarshallingUtil/putArrayInt32-02.adoc[`putArrayInt32`] 
| `putArrayInt32` overloads
| xref:BloombergLP/bslx/MarshallingUtil/putArrayInt40-05.adoc[`putArrayInt40`] 
| `putArrayInt40` overloads
| xref:BloombergLP/bslx/MarshallingUtil/putArrayInt48-06.adoc[`putArrayInt48`] 
| `putArrayInt48` overloads
| xref:BloombergLP/bslx/MarshallingUtil/putArrayInt56-0d.adoc[`putArrayInt56`] 
| `putArrayInt56` overloads
| xref:BloombergLP/bslx/MarshallingUtil/putArrayInt64-0d.adoc[`putArrayInt64`] 
| `putArrayInt64` overloads
| xref:BloombergLP/bslx/MarshallingUtil/putArrayInt8-05.adoc[`putArrayInt8`] 
| `putArrayInt8` overloads
| xref:BloombergLP/bslx/MarshallingUtil/putFloat32.adoc[`putFloat32`] 
| Store a four‐byte IEEE float into the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/putFloat64.adoc[`putFloat64`] 
| Store an eight‐byte IEEE double into the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/putInt16.adoc[`putInt16`] 
| Store a two‐byte integer into the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/putInt24.adoc[`putInt24`] 
| Store a three‐byte integer into the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/putInt32.adoc[`putInt32`] 
| Store a four‐byte integer into the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/putInt40.adoc[`putInt40`] 
| Store a five‐byte integer into the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/putInt48.adoc[`putInt48`] 
| Store a six‐byte integer into the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/putInt56.adoc[`putInt56`] 
| Store a seven‐byte integer into the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/putInt64.adoc[`putInt64`] 
| Store an eight‐byte integer into the specified `buffer`.
| xref:BloombergLP/bslx/MarshallingUtil/putInt8.adoc[`putInt8`] 
| Store a one‐byte integer into the specified `buffer`.
|===



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