API reference - Class QCryptographicHash

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QCryptographicHash

Sub-classes: Algorithm, QFlags_Algorithm

Public constructors

new QCryptographicHashnew(const QCryptographicHash_Algorithm method)Constructor QCryptographicHash::QCryptographicHash(QCryptographicHash::Algorithm method)

Public methods

void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidaddData(string data,
int length)
Method void QCryptographicHash::addData(const char *data, int length)
voidaddData(bytes data)Method void QCryptographicHash::addData(const QByteArray &data)
booladdData(QIODevice ptr device)Method bool QCryptographicHash::addData(QIODevice *device)
voidresetMethod void QCryptographicHash::reset()
[const]bytesresultMethod QByteArray QCryptographicHash::result()

Public static methods and constants

[static,const]QCryptographicHash_AlgorithmMd4Enum constant QCryptographicHash::Md4
[static,const]QCryptographicHash_AlgorithmMd5Enum constant QCryptographicHash::Md5
[static,const]QCryptographicHash_AlgorithmSha1Enum constant QCryptographicHash::Sha1
[static,const]QCryptographicHash_AlgorithmSha224Enum constant QCryptographicHash::Sha224
[static,const]QCryptographicHash_AlgorithmSha256Enum constant QCryptographicHash::Sha256
[static,const]QCryptographicHash_AlgorithmSha384Enum constant QCryptographicHash::Sha384
[static,const]QCryptographicHash_AlgorithmSha3_224Enum constant QCryptographicHash::Sha3_224
[static,const]QCryptographicHash_AlgorithmSha3_256Enum constant QCryptographicHash::Sha3_256
[static,const]QCryptographicHash_AlgorithmSha3_384Enum constant QCryptographicHash::Sha3_384
[static,const]QCryptographicHash_AlgorithmSha3_512Enum constant QCryptographicHash::Sha3_512
[static,const]QCryptographicHash_AlgorithmSha512Enum constant QCryptographicHash::Sha512
byteshash(bytes data,
const QCryptographicHash_Algorithm method)
Static method QByteArray QCryptographicHash::hash(const QByteArray &data, QCryptographicHash::Algorithm method)

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

Md4

Signature: [static,const] QCryptographicHash_Algorithm Md4

Description: Enum constant QCryptographicHash::Md4

Python specific notes:
The object exposes a readable attribute 'Md4'. This is the getter.

Md5

Signature: [static,const] QCryptographicHash_Algorithm Md5

Description: Enum constant QCryptographicHash::Md5

Python specific notes:
The object exposes a readable attribute 'Md5'. This is the getter.

Sha1

Signature: [static,const] QCryptographicHash_Algorithm Sha1

Description: Enum constant QCryptographicHash::Sha1

Python specific notes:
The object exposes a readable attribute 'Sha1'. This is the getter.

Sha224

Signature: [static,const] QCryptographicHash_Algorithm Sha224

Description: Enum constant QCryptographicHash::Sha224

Python specific notes:
The object exposes a readable attribute 'Sha224'. This is the getter.

Sha256

Signature: [static,const] QCryptographicHash_Algorithm Sha256

Description: Enum constant QCryptographicHash::Sha256

Python specific notes:
The object exposes a readable attribute 'Sha256'. This is the getter.

Sha384

Signature: [static,const] QCryptographicHash_Algorithm Sha384

Description: Enum constant QCryptographicHash::Sha384

Python specific notes:
The object exposes a readable attribute 'Sha384'. This is the getter.

Sha3_224

Signature: [static,const] QCryptographicHash_Algorithm Sha3_224

Description: Enum constant QCryptographicHash::Sha3_224

Python specific notes:
The object exposes a readable attribute 'Sha3_224'. This is the getter.

Sha3_256

Signature: [static,const] QCryptographicHash_Algorithm Sha3_256

Description: Enum constant QCryptographicHash::Sha3_256

Python specific notes:
The object exposes a readable attribute 'Sha3_256'. This is the getter.

Sha3_384

Signature: [static,const] QCryptographicHash_Algorithm Sha3_384

Description: Enum constant QCryptographicHash::Sha3_384

Python specific notes:
The object exposes a readable attribute 'Sha3_384'. This is the getter.

Sha3_512

Signature: [static,const] QCryptographicHash_Algorithm Sha3_512

Description: Enum constant QCryptographicHash::Sha3_512

Python specific notes:
The object exposes a readable attribute 'Sha3_512'. This is the getter.

Sha512

Signature: [static,const] QCryptographicHash_Algorithm Sha512

Description: Enum constant QCryptographicHash::Sha512

Python specific notes:
The object exposes a readable attribute 'Sha512'. This is the getter.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

addData

(1) Signature: void addData (string data, int length)

Description: Method void QCryptographicHash::addData(const char *data, int length)

(2) Signature: void addData (bytes data)

Description: Method void QCryptographicHash::addData(const QByteArray &data)

(3) Signature: bool addData (QIODevice ptr device)

Description: Method bool QCryptographicHash::addData(QIODevice *device)

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

hash

Signature: [static] bytes hash (bytes data, const QCryptographicHash_Algorithm method)

Description: Static method QByteArray QCryptographicHash::hash(const QByteArray &data, QCryptographicHash::Algorithm method)

This method is static and can be called without an instance.

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

new

Signature: [static] new QCryptographicHash new (const QCryptographicHash_Algorithm method)

Description: Constructor QCryptographicHash::QCryptographicHash(QCryptographicHash::Algorithm method)

This method creates an object of class QCryptographicHash.

Python specific notes:
This method is the default initializer of the object.

reset

Signature: void reset

Description: Method void QCryptographicHash::reset()

result

Signature: [const] bytes result

Description: Method QByteArray QCryptographicHash::result()