GI.Pango.Structs.Coverage

The Coverage structure represents a map from Unicode characters to CoverageLevel. It is an opaque structure with no public fields.

Exported types

newtype Coverage

Memory-managed wrapper type.

Constructors

Coverage (ManagedPtr Coverage)

Instances

WrappedPtr Coverage

Defined in GI.Pango.Structs.Coverage

Methods

wrappedPtrCalloc :: IO (Ptr Coverage)

wrappedPtrCopy :: Coverage -> IO Coverage

wrappedPtrFree :: Maybe (FunPtr (Ptr Coverage -> IO ()))

noCoverage :: Maybe Coverage

A convenience alias for Nothing :: Maybe Coverage.

Methods

get

coverageGet

Arguments

:: (HasCallStack, MonadIO m)

=> Coverage

coverage: a Coverage

-> Int32

index_: the index to check

-> m CoverageLevel

Returns: the coverage level of coverage for character index_.

Determine whether a particular index is covered by coverage

max

coverageMax

Arguments

:: (HasCallStack, MonadIO m)

=> Coverage

coverage: a Coverage

-> Coverage

other: another Coverage

-> m ()

Set the coverage for each index in coverage to be the max (better) value of the current coverage for the index and the coverage for the corresponding index in other.

set

coverageSet

Arguments

:: (HasCallStack, MonadIO m)

=> Coverage

coverage: a Coverage

-> Int32

index_: the index to modify

-> CoverageLevel

level: the new level for index_

-> m ()

Modify a particular index within coverage

toBytes

coverageToBytes

Arguments

:: (HasCallStack, MonadIO m)

=> Coverage

coverage: a Coverage

-> m ByteString

Convert a Coverage structure into a flat binary format

unref

coverageUnref

Arguments

:: (HasCallStack, MonadIO m)

=> Coverage

coverage: a Coverage

-> m ()

Decrease the reference count on the Coverage by one. If the result is zero, free the coverage and all associated memory.