gi-glib-2.0.30: GLib bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.GLib.Structs.ByteArray

Description

Contains the public fields of a GByteArray.

Synopsis

Exported types

newtype ByteArray Source #

Memory-managed wrapper type.

newZeroByteArray :: MonadIO m => m ByteArray Source #

Construct a ByteArray struct initialized to zero.

Methods

append

byteArrayAppend Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ByteString

array: a byte array

-> ByteString

data: the byte data to be added

-> m ByteString

Returns: The GByteArray

Adds the given bytes to the end of the GByteArray. The array will grow in size automatically if necessary.

freeToBytes

byteArrayFreeToBytes Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ByteString

array: a byte array

-> m Bytes

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

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

The GByteArray is freed unless the reference count of array is greater than one, in which the GByteArray 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 Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m ByteString

Returns: The new GByteArray

Creates a new GByteArray with a reference count of 1.

newTake

byteArrayNewTake Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ByteString

data: the byte data for the array

-> m ByteString

Returns: The new GByteArray

Creates a byte array containing the data. After this call, data belongs to the GByteArray and may no longer be modified by the caller. The memory of data has to be dynamically allocated and will eventually be freed with free.

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

Since: 2.32

prepend

byteArrayPrepend Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ByteString

array: a byte array

-> ByteString

data: the byte data to be added

-> m ByteString

Returns: The GByteArray

Adds the given data to the start of the GByteArray. The array will grow in size automatically if necessary.

ref

byteArrayRef Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ByteString

array: a byte array

-> m ByteString

Returns: The passed in GByteArray

Atomically increments the reference count of array by one. This function is thread-safe and may be called from any thread.

Since: 2.22

removeIndex

byteArrayRemoveIndex Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ByteString

array: a byte array

-> Word32

index_: the index of the byte to remove

-> m ByteString

Returns: The GByteArray

Removes the byte at the given index from a GByteArray. The following bytes are moved down one place.

removeIndexFast

byteArrayRemoveIndexFast Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ByteString

array: a byte array

-> Word32

index_: the index of the byte to remove

-> m ByteString

Returns: The GByteArray

Removes the byte at the given index from a GByteArray. The last element in the array is used to fill in the space, so this function does not preserve the order of the GByteArray. But it is faster than byteArrayRemoveIndex.

removeRange

byteArrayRemoveRange Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ByteString

array: a byte array

-> Word32

index_: the index of the first byte to remove

-> Word32

length: the number of bytes to remove

-> m ByteString

Returns: The GByteArray

Removes the given number of bytes starting at the given index from a GByteArray. The following elements are moved to close the gap.

Since: 2.4

setSize

byteArraySetSize Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ByteString

array: a byte array

-> Word32

length: the new size of the GByteArray

-> m ByteString

Returns: The GByteArray

Sets the size of the GByteArray, expanding it if necessary.

sizedNew

byteArraySizedNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Word32

reservedSize: the number of bytes preallocated

-> m ByteString

Returns: The new GByteArray

Creates a new GByteArray with reservedSize bytes preallocated. This avoids frequent reallocation, if you are going to add many bytes to the array. Note however that the size of the array is still 0.

sort

byteArraySort Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ByteString

array: a byte array

-> CompareFunc

compareFunc: the comparison function

-> m () 

Sorts a byte array, using compareFunc which should be a qsort()-style comparison function (returns less than zero for first arg is less than second arg, zero for equal, greater than zero if first arg is greater than second arg).

If two array elements compare equal, their order in the sorted array is undefined. If you want equal elements to keep their order (i.e. you want a stable sort) you can write a comparison function that, if two elements would otherwise compare equal, compares them by their addresses.

sortWithData

byteArraySortWithData Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ByteString

array: a byte array

-> CompareDataFunc

compareFunc: the comparison function

-> m () 

Like byteArraySort, but the comparison function takes an extra user data argument.

steal

byteArraySteal Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ByteString

array: a byte array

-> m ByteString

Returns: The allocated element data

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 Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ByteString

array: a byte array

-> 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 GByteArray

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

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

get byteArray #data

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

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 GByteArray

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

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

get byteArray #len

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

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

set byteArray [ #len := value ]