Source file glib_bytes.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
(**************************************************************************)
(*                ocgtk - OCaml bindings for GTK4                         *)
(*                                                                        *)
(*    This program is free software; you can redistribute it              *)
(*    and/or modify it under the terms of the GNU Library General         *)
(*    Public License version 2, as published by the                       *)
(*    Free Software Foundation with the exception described in file       *)
(*    COPYING which comes with the library.                               *)
(*                                                                        *)
(*    Based on lablgtk3 (https://github.com/garrigue/lablgtk)             *)
(*                                                                        *)
(**************************************************************************)

(** GLib.Bytes - Immutable reference-counted byte buffer

    GBytes wraps an immutable block of memory with reference counting. Used for
    texture data, file contents, serialized data, etc. *)

type t
(** Opaque GBytes type - backed by GBytes* with g_bytes_unref finalizer *)

external create : string -> t = "ml_g_bytes_new"
(** Create a GBytes from an OCaml string (copies the data) *)

external to_string : t -> string = "ml_g_bytes_get_data_as_string"
(** Copy the GBytes data into a new OCaml string *)

external size : t -> int = "ml_g_bytes_get_size"
(** Get the size of the byte buffer *)