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 refcounted data type representing an immutable sequence of zero or more bytes from an unspecified origin.

The purpose of a Bytes 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 Bytes without coordinating their activities, resting assured that the byte data will not change or move while they hold a reference.

A Bytes can come from many different origins that may have different procedures for freeing the memory region. Examples are memory from malloc, from memory slices, from a MappedFile or memory from other allocators.

Bytes work well as keys in GenericSet. Use g_bytes_equal and hash as parameters to g_hash_table_new or GenericSet. Bytes can also be used as keys in a Tree by passing the compare function to g_tree_new.

The data pointed to by this bytes must not be modified. For a mutable array of bytes see ByteArray. Use unref_to_array to create a mutable array for a Bytes sequence. To create an immutable Bytes from a mutable ByteArray, use the 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 Bytes from data.
public static ByteArray unref_to_array (owned Bytes bytes)
Unreferences the bytes, and returns a new mutable ByteArray containing the same byte data.
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 Bytes from data.
public Bytes.from_bytes (Bytes bytes, size_t offset, size_t length)
Creates a Bytes which is a subsection of another Bytes.
public Bytes.static (uint8[]? data)
Creates a new Bytes from static data.
public Bytes.take (owned uint8[]? data)
Creates a new Bytes from data.
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 Bytes values.
public unowned uint8[]? get_data ()
Get the byte data in the Bytes.
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 Bytes.
public uint hash ()
Creates an integer hash code for the byte data in the Bytes.
public Bytes slice (size_t start, size_t end)
Extracts bytes from GLib.Bytes and returns it.