QCryptographicHash Class

The QCryptographicHash class provides a way to generate cryptographic hashes. More…

List of all members, including inherited members

Public Types

Public Functions

Static Public Members

Detailed Description

QCryptographicHash computes a message digest of the data added to it with addData(). Call result() to read the digest. More data may be added afterwards, and result() then returns the digest of all the data so far. For a single buffer, use the static hash() function.

QCryptographicHash h(QCryptographicHash::Sha256);
h.addData(QByteArrayView("hello "));
h.addData(QByteArrayView("world"));
QByteArray digest = h.result().toHex();

See also QMessageAuthenticationCode.

Differences from Qt

Member Type Documentation

enum QCryptographicHash::Algorithm

Selects the hash algorithm.

See also hashLength().

Member Function Documentation

[explicit] QCryptographicHash::QCryptographicHash(Algorithm method)

Constructs an object that can compute hashes with the algorithm method.

See also hash().

QCryptographicHash::QCryptographicHash(QCryptographicHash &&other)

Move-constructs an object from other. other must not be used afterwards except to be assigned to or destroyed.

QCryptographicHash::~QCryptographicHash()

Destroys the object.

void QCryptographicHash::addData(QByteArrayView data)

Adds data to the data being hashed.

See also result().

void QCryptographicHash::addData(const char *data, qsizetype length)

This is an overloaded function.

Adds the length bytes at data to the data being hashed.

bool QCryptographicHash::addData(QIODevice *device)

This is an overloaded function.

Reads from device until it is exhausted and adds the data. Returns true if all the data was read; returns false if device is null, not open or not readable, or if reading stopped before the end.

void QCryptographicHash::addDataWithoutCopy(QByteArrayView data)

Adds data to the hash. Nt processes the data immediately, so this is the same as addData().

This function was introduced in 6.8.

Algorithm QCryptographicHash::algorithm() const

Returns the algorithm that the object was constructed with.

[static] QByteArray QCryptographicHash::hash(QByteArrayView data, Algorithm method)

Returns the digest of data computed with method.

See also addData() and result().

[static] QByteArrayView QCryptographicHash::hashInto(QSpan<char> buffer, QByteArrayView data, Algorithm method)

Computes the digest of data with method and writes it to buffer. Returns a view of the digest inside buffer, or a null view if buffer is smaller than hashLength() of method or the digest could not be computed.

This function was introduced in 6.8.

See also hash() and hashLength().

[static] QByteArrayView QCryptographicHash::hashInto(QSpan<unsigned char> buffer, QByteArrayView data, Algorithm method)

This is an overloaded function.

Writes the digest into buffer, a span of unsigned char; the result is computed over data with method.

This function was introduced in 6.8.

[static] QByteArrayView QCryptographicHash::hashInto(QSpan<std::byte> buffer, QByteArrayView data, Algorithm method)

This is an overloaded function.

Writes the digest into buffer, a span of std::byte; the result is computed over data with method.

This function was introduced in 6.8.

[static] int QCryptographicHash::hashLength(Algorithm method)

Returns the size in bytes of the digest that method produces, or 0 if method is not supported.

See also supportsAlgorithm().

QCryptographicHash & QCryptographicHash::operator=(QCryptographicHash &&other)

Move-assigns other to this object and returns a reference to this object. other must not be used afterwards except to be assigned to or destroyed.

void QCryptographicHash::reset()

Resets the object, discarding all data added so far.

See also addData().

QByteArray QCryptographicHash::result() const

Returns the digest of the data added so far. The object stays usable, and more data may be added afterwards.

See also resultView() and reset().

QByteArrayView QCryptographicHash::resultView() const

Returns the digest of the data added so far as a view. The view is valid until the next call to resultView() or until the object is modified or destroyed.

See also result().

[static] bool QCryptographicHash::supportsAlgorithm(Algorithm method)

Returns true if method is supported; otherwise returns false.

See also hashLength().

void QCryptographicHash::swap(QCryptographicHash &other)

Swaps this hash with other.

This function was introduced in 5.10.