Bytes

Object Hierarchy:

Description:

[ Compact ]
[ Version ( since = "2.32" ) ]
[ CCode ( cprefix = "g_bytes_" , ref_function = "g_bytes_ref" , type_id = "G_TYPE_BYTES" , unref_function = "g_bytes_unref" ) ]
public class Bytes

A simple reference counted data type representing an immutable sequence of zero or more bytes from an unspecified origin.

The purpose of a `GBytes` is to keep the memory region that it holds alive for as long as anyone holds a reference to the bytes. When the last reference count is dropped, the memory is released. Multiple unrelated callers can use byte data in the `GBytes` without coordinating their activities, resting assured that the byte data will not change or move while they hold a reference.

A `GBytes` can come from many different origins that may have different procedures for freeing the memory region. Examples are memory from [ func@GLib.malloc], from memory slices, from a [struct@GLib.MappedFile] or memory from other allocators.

`GBytes` work well as keys in [struct@GLib.HashTable]. Use [method@GLib.Bytes.equal] and [method@GLib.Bytes.hash] as parameters to [ func@GLib.HashTable.new] or [func@GLib.HashTable.new_full]. `GBytes` can also be used as keys in a [struct@GLib.Tree] by passing the [ method@GLib.Bytes.compare] function to [ctor@GLib.Tree.new].

The data pointed to by this bytes must not be modified. For a mutable array of bytes see [struct@GLib.ByteArray]. Use [ method@GLib.Bytes.unref_to_array] to create a mutable array for a `GBytes` sequence. To create an immutable `GBytes` from a mutable [ struct@GLib.ByteArray], use the [func@GLib.ByteArray.free_to_bytes] function.

Namespace: GLib

Package: glib-2.0

Content:

Properties:

public int length { get; }
The size of the byte data in the GLib.Bytes.

Static methods:

public static Bytes new_with_owner<T> (uint8[]? data, owned T owner = null)
Creates a [struct@GLib.
public static ByteArray unref_to_array (owned Bytes bytes)
Unreferences the bytes, and returns a new mutable [struct@GLib.
public static uint8[] unref_to_data (owned Bytes bytes)
Unreferences the bytes, and returns a pointer the same byte data contents.

Creation methods:

public Bytes (uint8[]? data)
Creates a new [struct@GLib.
public Bytes.from_bytes (Bytes bytes, size_t offset, size_t length)
Creates a [struct@GLib.
public Bytes.static (uint8[]? data)
Creates a new [struct@GLib.
public Bytes.take (owned uint8[]? data)
Creates a new [struct@GLib.
public Bytes.with_free_func (owned uint8[]? data, DestroyNotify? free_func, void* user_data)

Methods:

public uint8 @get (int index)
Returns the byte at the given index
public int compare (Bytes bytes2)
Compares the two [struct@GLib.
public unowned uint8[]? get_data ()
Get the byte data in the [struct@GLib.
public void* get_region (size_t element_size, size_t offset, size_t n_elements)
Gets a pointer to a region in this.
public size_t get_size ()
Get the size of the byte data in the [struct@GLib.
public uint hash ()
Creates an integer hash code for the byte data in the [struct@GLib.
public Bytes slice (size_t start, size_t end)
Extracts bytes from GLib.Bytes and returns it.