GI.GLib.Structs.Hmac

An opaque structure representing a HMAC operation. To create a new GHmac, use g_hmac_new(). To free a GHmac, use hmacUnref.

Since: 2.30

Exported types

newtype Hmac

Memory-managed wrapper type.

Constructors

Hmac (ManagedPtr Hmac)

Instances

Eq Hmac

Defined in GI.GLib.Structs.Hmac

Methods

(==) :: Hmac -> Hmac -> Bool

(/=) :: Hmac -> Hmac -> Bool

BoxedPtr Hmac

Defined in GI.GLib.Structs.Hmac

Methods

boxedPtrCopy :: Hmac -> IO Hmac

boxedPtrFree :: Hmac -> IO ()

ManagedPtrNewtype Hmac

Defined in GI.GLib.Structs.Hmac

Methods

toManagedPtr :: Hmac -> ManagedPtr Hmac

Methods

Click to display all available methods, including inherited ones

Methods

unref, update.

Getters

getDigest, getString.

Setters

None.

getDigest

hmacGetDigest

Arguments

:: (HasCallStack, MonadIO m)

=> Hmac

hmac: a Hmac

-> ByteString

buffer: output buffer

-> m ()

Gets the digest from checksum as a raw binary array and places it into buffer. The size of the digest depends on the type of checksum.

Once this function has been called, the Hmac is closed and can no longer be updated with checksumUpdate.

Since: 2.30

getString

hmacGetString

Arguments

:: (HasCallStack, MonadIO m)

=> Hmac

hmac: a Hmac

-> m Text

Returns: the hexadecimal representation of the HMAC. The returned string is owned by the HMAC and should not be modified or freed.

Gets the HMAC as a hexadecimal string.

Once this function has been called the Hmac can no longer be updated with hmacUpdate.

The hexadecimal characters will be lower case.

Since: 2.30

unref

hmacUnref

Arguments

:: (HasCallStack, MonadIO m)

=> Hmac

hmac: a Hmac

-> m ()

Atomically decrements the reference count of hmac by one.

If the reference count drops to 0, all keys and values will be destroyed, and all memory allocated by the hash table is released. This function is MT-safe and may be called from any thread. Frees the memory allocated for hmac.

Since: 2.30

update

hmacUpdate

Arguments

:: (HasCallStack, MonadIO m)

=> Hmac

hmac: a Hmac

-> ByteString

data: buffer used to compute the checksum

-> m ()

Feeds data into an existing Hmac.

The HMAC must still be open, that is hmacGetString or hmacGetDigest must not have been called on hmac.

Since: 2.30