[#BloombergLP-bdlde-Crc32]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlde.adoc[bdlde]::Crc32
:relfileprefix: ../../
:mrdocs:

This class represents a CRC‐32 checksum value that can be updated as data is provided.

== Synopsis

Declared in `<bdlde_crc32.h>`

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

== Description

More generally, this class supports a complete set of _value semantic_ operations, including copy construction, assignment, equality comparison, `ostream` printing, and `bdex` serialization. (A precise operational definition of when two objects have the same value can be found in the description of `operator==` for the 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 class 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/bdlde/Crc32/2constructor-08.adoc[`Crc32`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdlde/Crc32/operator_assign.adoc[`operator=`] 
| Assign to this checksum the value of the specified `rhs` checksum, and return a reference to this modifiable checksum.
| xref:BloombergLP/bdlde/Crc32/bdexStreamIn.adoc[`bdexStreamIn`] 
| Assign to this object the value read from the specified input stream.
| xref:BloombergLP/bdlde/Crc32/bdexStreamOut.adoc[`bdexStreamOut`] 
| Write this value to the specified output `stream`.
| xref:BloombergLP/bdlde/Crc32/checksum.adoc[`checksum`] 
| Return the current value of this checksum.
| xref:BloombergLP/bdlde/Crc32/checksumAndReset.adoc[`checksumAndReset`] 
| Return the current value of this checksum and set the value of this checksum to the value the default constructor provides.
| xref:BloombergLP/bdlde/Crc32/print.adoc[`print`] 
| Format this checksum to the specified output `stream`.
| xref:BloombergLP/bdlde/Crc32/reset.adoc[`reset`] 
| Reset the value of this checksum to the value the default constructor provides.
| xref:BloombergLP/bdlde/Crc32/update.adoc[`update`] 
| Update this checksum to incorporate the specified `data`.
| xref:BloombergLP/bdlde/Crc32/view.adoc[`view`] 
| Return the current value of this checksum.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlde/Crc32/maxSupportedBdexVersion-02.adoc[`maxSupportedBdexVersion`] 
| `maxSupportedBdexVersion` overloads
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bdlde/operator_eq-0a.adoc[BloombergLP::bdlde::operator==]`
| Return `true` if the specified `lhs` and `rhs` checksums have the same value, and `false` otherwise.
|===

== Non-Member Functions

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


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