class GLib::Bytes


A simple refcounted 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 g_malloc(), from memory slices, from a #GMappedFile or memory from other allocators.

#GBytes work well as keys in #GHashTable. Use g_bytes_equal() and g_bytes_hash() as parameters to g_hash_table_new() or g_hash_table_new_full(). #GBytes can also be used as keys in a #GTree by passing the g_bytes_compare() function to g_tree_new().

The data pointed to by this bytes must not be modified. For a mutable array of bytes see #GByteArray. Use g_bytes_unref_to_array() to create a mutable array for a #GBytes sequence. To create an immutable #GBytes from a mutable #GByteArray, use the g_byte_array_free_to_bytes() function.

Defined in:



Class Method Summary

Instance Method Summary

Constructor Detail

def : Pointer(Void), transfer : GICrystal::Transfer) #

[View source]
def : Pointer, size : Int32) #

[View source]

Class Method Detail

def self.g_type : UInt64 #

Returns the type id (GType) registered in GLib type system.

[View source]

Instance Method Detail

def compare(bytes2 : GLib::Bytes) : Int32 #

[View source]
def data : ::Bytes | Nil #

[View source]
def equal(bytes2 : GLib::Bytes) : Bool #

[View source]
def finalize #

[View source]
def hash : UInt32 #
Description copied from class Object

Generates an UInt64 hash value for this object.

This method must have the property that a == b implies a.hash == b.hash.

The hash value is used along with == by the Hash class to determine if two objects reference the same hash key.

Subclasses must not override this method. Instead, they must define hash(hasher), though usually the macro def_hash can be used to generate this method.

[View source]
def new_from_bytes(offset : UInt64, length : UInt64) : GLib::Bytes #

[View source]
def region(element_size : UInt64, offset : UInt64, n_elements : UInt64) : Pointer(Void) | Nil #

[View source]
def size : UInt64 #

[View source]
def to_unsafe : Pointer(Void) #

[View source]