GI.GLib.Structs.ByteArray

Contains the public fields of a GByteArray.

Exported types

newtype ByteArray

Memory-managed wrapper type.

Constructors

ByteArray (ManagedPtr ByteArray)

Instances

Eq ByteArray

Defined in GI.GLib.Structs.ByteArray

Methods

(==) :: ByteArray -> ByteArray -> Bool

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

GBoxed ByteArray

Defined in GI.GLib.Structs.ByteArray

ManagedPtrNewtype ByteArray

Defined in GI.GLib.Structs.ByteArray

Methods

toManagedPtr :: ByteArray -> ManagedPtr ByteArray

TypedObject ByteArray

Defined in GI.GLib.Structs.ByteArray

Methods

glibType :: IO GType

HasParentTypes ByteArray

Defined in GI.GLib.Structs.ByteArray

tag ~ 'AttrSet => Constructible ByteArray tag

Defined in GI.GLib.Structs.ByteArray

Methods

new :: MonadIO m => (ManagedPtr ByteArray -> ByteArray) -> [AttrOp ByteArray tag] -> m ByteArray

IsGValue (Maybe ByteArray)

Convert ByteArray to and from GValue. See toGValue and fromGValue.

Defined in GI.GLib.Structs.ByteArray

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe ByteArray -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe ByteArray)

type ParentTypes ByteArray

Defined in GI.GLib.Structs.ByteArray

type ParentTypes ByteArray = '[] :: [Type]

newZeroByteArray :: MonadIO m => m ByteArray

Construct a ByteArray struct initialized to zero.

Methods

free

byteArrayFree

Arguments

:: (HasCallStack, MonadIO m)

=> ByteString

array: a ByteArray

-> Bool

freeSegment: if True the actual byte data is freed as well

-> m Word8

Returns: the element data if freeSegment is False, otherwise Nothing. The element data should be freed using free.

Frees the memory allocated by the ByteArray. If freeSegment is True it frees the actual byte data. If the reference count of array is greater than one, the ByteArray wrapper is preserved but the size of array will be set to zero.

freeToBytes

byteArrayFreeToBytes

Arguments

:: (HasCallStack, MonadIO m)

=> ByteString

array: a ByteArray

-> m Bytes

Returns: a new immutable Bytes representing same byte data that was in the array

Transfers the data from the ByteArray into a new immutable Bytes.

The ByteArray is freed unless the reference count of array is greater than one, the ByteArray wrapper is preserved but the size of array will be set to zero.

This is identical to using bytesNewTake and byteArrayFree together.

Since: 2.32

new

byteArrayNew

Arguments

:: (HasCallStack, MonadIO m)

=> m ByteString

Returns: the new ByteArray

Creates a new ByteArray with a reference count of 1.

newTake

byteArrayNewTake

Arguments

:: (HasCallStack, MonadIO m)

=> ByteString

data: byte data for the array

-> m ByteString

Returns: a new ByteArray

Create byte array containing the data. The data will be owned by the array and will be freed with free, i.e. it could be allocated using strdup.

Do not use it if len is greater than G_MAXUINT. ByteArray stores the length of its data in guint, which may be shorter than gsize.

Since: 2.32

steal

byteArraySteal

Arguments

:: (HasCallStack, MonadIO m)

=> ByteString

array: a ByteArray.

-> m (Word8, Word64)

Returns: the element data, which should be freed using free.

Frees the data in the array and resets the size to zero, while the underlying array is preserved for use elsewhere and returned to the caller.

Since: 2.64

unref

byteArrayUnref

Arguments

:: (HasCallStack, MonadIO m)

=> ByteString

array: A ByteArray

-> m ()

Atomically decrements the reference count of array by one. If the reference count drops to 0, all memory allocated by the array is released. This function is thread-safe and may be called from any thread.

Since: 2.22

Properties

data

a pointer to the element data. The data may be moved as elements are added to the ByteArray

getByteArrayData :: MonadIO m => ByteArray -> m Word8

Get the value of the “data” field. When overloading is enabled, this is equivalent to

get byteArray #data

setByteArrayData :: MonadIO m => ByteArray -> Word8 -> m ()

Set the value of the “data” field. When overloading is enabled, this is equivalent to

set byteArray [ #data := value ]

len

the number of elements in the ByteArray

getByteArrayLen :: MonadIO m => ByteArray -> m Word32

Get the value of the “len” field. When overloading is enabled, this is equivalent to

get byteArray #len

setByteArrayLen :: MonadIO m => ByteArray -> Word32 -> m ()

Set the value of the “len” field. When overloading is enabled, this is equivalent to

set byteArray [ #len := value ]