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

This `class` represents a SHA‐384 digest that can be updated as additional data is provided.

== Synopsis

Declared in `<bdlde_sha2.h>`

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

== Description

More generally, this class supports a complete set of _value_ _semantic_ operations, including copy construction, assignment, equality comparison, and `ostream` printing. (A precise operational definition of when two instances have the same value can be found in the description of `operator==` for the class.) This container is _exception_ _neutral_ with no guarantee of rollback: if an exception is thrown during the invocation of a method on a pre‐existing instance, 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/Sha384/2constructor-03.adoc[`Sha384`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdlde/Sha384/loadDigest.adoc[`loadDigest`] 
| Load the value of this SHA‐2 digest into the specified `result`.
| xref:BloombergLP/bdlde/Sha384/loadDigestAndReset.adoc[`loadDigestAndReset`] 
| Load the current value of this SHA‐2 digest into the specified `result` and set the value of this SHA‐2 digest to the value provided by the default constructor.
| xref:BloombergLP/bdlde/Sha384/print.adoc[`print`] 
| Format the current value of this SHA‐2 digest to the specified output `stream` and return a reference to the modifiable `stream`.
| xref:BloombergLP/bdlde/Sha384/reset.adoc[`reset`] 
| Reset the value of this SHA‐2 digest to the value provided by the default constructor.
| xref:BloombergLP/bdlde/Sha384/update.adoc[`update`] 
| Update the value of this SHA‐2 digest to incorporate the specified `data` having the specified `length` in bytes. If the current state is the default state, the resultant value of this SHA‐2 digest is the application of the SHA‐2 algorithm upon the currently given `data` of the given `length`. If this digest has been previously provided data and has not been subsequently reset, the current state is not the default state and the resultant value is equivalent to applying the SHA‐2 algorithm upon the concatenation of all the provided data. The behavior is undefined unless the range `[data, data + length)]` is a valid range. Note that if `data` is 0, then `length` must also be 0.
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlde/Sha384/k_DIGEST_SIZE.adoc[`k_DIGEST_SIZE`] 
| The size (in bytes) of the output
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bdlde/operator_eq-00.adoc[BloombergLP::bdlde::operator==]`
| Return `true` if the specified `lhs` and `rhs` SHA digests have the same value, and `false` otherwise. Two digests have the same value if, after applying any number of equivalent updates to both (possibly including no updates), the values obtained from their respective `loadDigest` methods are identical.
|===

== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlde/operator_not_eq-09a.adoc[`operator!=`]
| Return `true` if the specified `lhs` and `rhs` SHA digests do not have the same value, and `false` otherwise. Two digests do not have the same value if there exists a set of updates (possibly including the empty set) that, if applied to both, lead to different values being obtained from their respective `loadDigest` methods.
|===


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