gi-glib-0.2.46.13: GLib bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.GLib.Structs.Bytes

Contents

Description

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.

GHashTable. Use g_bytes_equal() and g_bytes_hash() as parameters to g_hash_table_new() or g_hash_table_new_full(). 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 from a mutable #GByteArray, use the g_byte_array_free_to_bytes() function.

Synopsis

Exported types

newtype Bytes Source

Constructors

Bytes (ForeignPtr Bytes) 

Instances

BoxedObject Bytes Source 

Methods

boxedType :: Bytes -> IO GType

((~) * info (ResolveBytesMethod t Bytes), MethodInfo * info Bytes p) => IsLabel t (Bytes -> p) Source 

Methods

fromLabel :: Proxy# Symbol t -> Bytes -> p

((~) * info (ResolveBytesMethod t Bytes), MethodInfo * info Bytes p) => IsLabelProxy t (Bytes -> p) Source 

Methods

fromLabelProxy :: Proxy Symbol t -> Bytes -> p

((~) (TYPE Lifted) signature (Word64 -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) BytesUnrefToDataMethodInfo Bytes signature Source 
((~) (TYPE Lifted) signature (m ByteString), MonadIO m) => MethodInfo (TYPE Lifted) BytesUnrefToArrayMethodInfo Bytes signature Source 
((~) (TYPE Lifted) signature (m ()), MonadIO m) => MethodInfo (TYPE Lifted) BytesUnrefMethodInfo Bytes signature Source 
((~) (TYPE Lifted) signature (m Bytes), MonadIO m) => MethodInfo (TYPE Lifted) BytesRefMethodInfo Bytes signature Source 
((~) (TYPE Lifted) signature (Word64 -> Word64 -> m Bytes), MonadIO m) => MethodInfo (TYPE Lifted) BytesNewFromBytesMethodInfo Bytes signature Source 
((~) (TYPE Lifted) signature (m Word32), MonadIO m) => MethodInfo (TYPE Lifted) BytesHashMethodInfo Bytes signature Source 
((~) (TYPE Lifted) signature (m Word64), MonadIO m) => MethodInfo (TYPE Lifted) BytesGetSizeMethodInfo Bytes signature Source 
((~) (TYPE Lifted) signature (m ByteString), MonadIO m) => MethodInfo (TYPE Lifted) BytesGetDataMethodInfo Bytes signature Source 
((~) (TYPE Lifted) signature (Bytes -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) BytesEqualMethodInfo Bytes signature Source 
((~) (TYPE Lifted) signature (Bytes -> m Int32), MonadIO m) => MethodInfo (TYPE Lifted) BytesCompareMethodInfo Bytes signature Source 

Methods

bytesCompare

bytesEqual

bytesGetData

bytesGetSize

bytesHash

bytesNew

bytesNewFromBytes

bytesNewTake

bytesRef

data BytesRefMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m Bytes), MonadIO m) => MethodInfo (TYPE Lifted) BytesRefMethodInfo Bytes signature Source 

bytesUnref

data BytesUnrefMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m ()), MonadIO m) => MethodInfo (TYPE Lifted) BytesUnrefMethodInfo Bytes signature Source 

bytesUnref :: MonadIO m => Bytes -> m () Source

bytesUnrefToArray

bytesUnrefToData