Checksum

Description GLib provides a generic API for computing checksums (or "digests") for a sequence of arbitrary bytes, using various hashing algorithms like MD5, SHA-1 and SHA-256. Checksums are commonly used in various environments and specifications. GLib supports incremental checksums using the GChecksum data structure, by calling g_checksum_update() as long as there's data available and then using g_checksum_get_string() or g_checksum_get_digest() to compute the checksum and return it either as a string in hexadecimal form, or as a raw sequence of bytes. To compute the checksum for binary blobs and NUL-terminated strings in one go, use the convenience functions g_compute_checksum_for_data() and g_compute_checksum_for_string(), respectively. Support for checksums has been added in GLib 2.16

class Checksum {

protected

GChecksum* gChecksum;

GChecksum* getChecksumStruct();

void* getStruct();

this(GChecksum* gChecksum);

static gssize typeGetLength(GChecksumType checksumType);

this(GChecksumType checksumType);

Checksum copy();

void free();

void reset();

void update(char* data, gssize length);

string getString();

void getDigest(ubyte* buffer, gsize* digestLen);

static string gComputeChecksumForData(GChecksumType checksumType, char* data, gsize length);

static string gComputeChecksumForString(GChecksumType checksumType, string str, gssize length);

}

Constructors

this this(GChecksum* gChecksum): Sets our main struct and passes it to the parent class
this this(GChecksumType checksumType): Creates a new GChecksum, using the checksum algorithm checksum_type. If the checksum_type is not known, NULL is returned. A GChecksum can be used to compute the checksum, or digest, of an arbitrary binary blob, using different hashing algorithms. A GChecksum works by feeding a binary blob through g_checksum_update() until there is data to be checked; the digest can then be extracted using g_checksum_get_string(), which will return the checksum as a hexadecimal string; or g_checksum_get_digest(), which will return a vector of raw bytes. Once either g_checksum_get_string() or g_checksum_get_digest() have been called on a GChecksum, the checksum will be closed and it won't be possible to call g_checksum_update() on it anymore. Since 2.16

Members

Functions

copy Checksum copy(): Copies a GChecksum. If checksum has been closed, by calling g_checksum_get_string() or g_checksum_get_digest(), the copied checksum will be closed as well. Since 2.16
free void free(): Frees the memory allocated for checksum. Since 2.16
getChecksumStruct GChecksum* getChecksumStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
getDigest void getDigest(ubyte* buffer, gsize* digestLen): Gets the digest from checksum as a raw binary vector and places it into buffer. The size of the digest depends on the type of checksum. Once this function has been called, the GChecksum is closed and can no longer be updated with g_checksum_update(). Since 2.16
getString string getString(): Gets the digest as an hexadecimal string. Once this function has been called the GChecksum can no longer be updated with g_checksum_update(). The hexadecimal characters will be lower case. Since 2.16
getStruct void* getStruct(): the main Gtk struct as a void*
reset void reset(): Resets the state of the checksum back to its initial state. Since 2.18
update void update(char* data, gssize length): Feeds data into an existing GChecksum. The checksum must still be open, that is g_checksum_get_string() or g_checksum_get_digest() must not have been called on checksum. Since 2.16

Static functions

gComputeChecksumForData string gComputeChecksumForData(GChecksumType checksumType, char* data, gsize length): Computes the checksum for a binary data of length. This is a convenience wrapper for g_checksum_new(), g_checksum_get_string() and g_checksum_free(). The hexadecimal string returned will be in lower case. Since 2.16
gComputeChecksumForString string gComputeChecksumForString(GChecksumType checksumType, string str, gssize length): Computes the checksum of a string. The hexadecimal string returned will be in lower case. Since 2.16
typeGetLength gssize typeGetLength(GChecksumType checksumType): Gets the length in bytes of digests of type checksum_type Since 2.16

Variables

gChecksum GChecksum* gChecksum;: the main Gtk struct