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

This class provides a type to represent a pointer to non‐modifiable binary data and an integral size value.

== Synopsis

Declared in `<bdld_datumbinaryref.h>`

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

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdld/DatumBinaryRef/SizeType.adoc[`SizeType`] 
| `SizeType` is an alias for an unsigned integral value, representing the length of the binary array.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdld/DatumBinaryRef/2constructor-00.adoc[`DatumBinaryRef`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdld/DatumBinaryRef/data.adoc[`data`] 
| Return the pointer to the non‐modifiable binary data.
| xref:BloombergLP/bdld/DatumBinaryRef/print.adoc[`print`] 
| Write the value of this object to the specified output `stream` in a human‐readable format, and return a reference to the modifyable `stream`. Optionally specify an initial indentation `level`, whose absolute value is incremented recursively for nested objects. If `level` is specified, optionally specify `spacesPerLevel`, whose absolute value indicates the number of spaces per indentation level for this and all of its nested objects. If `level` is negative, suppress indentation of the first line. If `spacesPerLevel` is negative, format the entire output on one line, suppressing all but the initial indentation (as governed by `level`). If `stream` is not valid on entry, this operation has no effect. Note that this human‐readable format is not fully specified, and can change without notice.
| xref:BloombergLP/bdld/DatumBinaryRef/size.adoc[`size`] 
| Return the size of the binary data.
| xref:BloombergLP/bdld/DatumBinaryRef/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration<DatumBinaryRef, HasPrintMethod>`] 
| `DatumBinaryRef` is trivially copyable.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdld/operator_not_eq-0a0.adoc[`operator!=`]
| Return `true` if the specified `lhs` and `rhs` have different values, and `true` otherwise. Two `DatumBinaryRef` objects have different values if they refer to arrays of bytes of different sizes or having a different content.
| xref:BloombergLP/bdld/operator_lt-09b.adoc[`operator<`]
| Return `true` if the specified `lhs` compares smaller than the specified `rhs`, and `false` otherwise. A byte comparision is performed using memcpy.
| xref:BloombergLP/bdld/operator_le-07.adoc[`operator<=`]
| Return `true` if the specified `lhs` compares smaller than or equal to the specified `rhs`, and `false` otherwise. A byte comparision is performed using memcpy.
| xref:BloombergLP/bdld/operator_eq-08f.adoc[`operator==`]
| Return `true` if the specified `lhs` and `rhs` have the same value, and `false` otherwise. Two `DatumBinaryRef` objects have the same value if they refer to arrays of bytes of the same size and having the same content.
| xref:BloombergLP/bdld/operator_gt-0e.adoc[`operator>`]
| Return `true` if the specified `lhs` compares larger than the specified `rhs`, and `false` otherwise. A byte comparision is performed using memcpy.
| xref:BloombergLP/bdld/operator_ge-0b5.adoc[`operator>=`]
| Return `true` if the specified `lhs` compares larger than or equal to the specified `rhs`, and `false` otherwise. A byte comparision is performed using memcpy.
|===


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