GLib.ByteArray¶
Fields¶
Name |
Type |
Access |
Description |
---|---|---|---|
data |
r/w |
a pointer to the element data. The data may be moved as elements are added to the |
|
len |
r/w |
the number of elements in the |
Methods¶
class |
|
class |
|
class |
|
class |
|
class |
|
class |
|
Details¶
- class GLib.ByteArray¶
Contains the public fields of a
GLib.ByteArray
.- classmethod free(array, free_segment)[source]¶
- Parameters:
array (
bytes
) – aGLib.ByteArray
free_segment (
bool
) – ifTrue
the actual byte data is freed as well
- Returns:
the element data if free_segment is
False
, otherwiseNone
. The element data should be freed usingGLib.free
().- Return type:
Frees the memory allocated by the
GLib.ByteArray
. If free_segment isTrue
it frees the actual byte data. If the reference count of array is greater than one, theGLib.ByteArray
wrapper is preserved but the size of array will be set to zero.
- classmethod free_to_bytes(array)[source]¶
- Parameters:
array (
bytes
) – aGLib.ByteArray
- Returns:
a new immutable
GLib.Bytes
representing same byte data that was in the array- Return type:
Transfers the data from the
GLib.ByteArray
into a new immutableGLib.Bytes
.The
GLib.ByteArray
is freed unless the reference count of array is greater than one, theGLib.ByteArray
wrapper is preserved but the size of array will be set to zero.This is identical to using
GLib.Bytes.new_take
() andGLib.ByteArray.free
() together.New in version 2.32.
- classmethod new()[source]¶
- Returns:
the new
GLib.ByteArray
- Return type:
Creates a new
GLib.ByteArray
with a reference count of 1.
- classmethod new_take(data)[source]¶
- Parameters:
data (
bytes
) – byte data for the array- Returns:
a new
GLib.ByteArray
- Return type:
Creates a byte array containing the data. After this call, data belongs to the
GLib.ByteArray
and may no longer be modified by the caller. The memory of data has to be dynamically allocated and will eventually be freed withGLib.free
().Do not use it if len is greater than %G_MAXUINT.
GLib.ByteArray
stores the length of its data inint
, which may be shorter than #gsize.New in version 2.32.
- classmethod steal(array)[source]¶
- Parameters:
array (
bytes
) – aGLib.ByteArray
.- Returns:
the element data, which should be freed using
GLib.free
().- len:
pointer to retrieve the number of elements of the original array
- Return type:
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.
New in version 2.64.
- classmethod unref(array)[source]¶
- Parameters:
array (
bytes
) – AGLib.ByteArray
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.
New in version 2.22.