package extunix

  1. Overview
  2. Docs
Collection of thin bindings to various low-level system API

Install 

dune-project
 Dependency

ygrek.org Readme Edit opam file Versions (10)

Authors

  1. A
    Andre Nathan
  2. A
    Antonin Décimo
  3. D
    Dmitry Grebeniuk
  4. F
    François Bobot
  5. G
    Gerd Stolpmann
  6. G
    Goswin von Brederlow
  7. J
    Joshua Smith
  8. K
    Kaustuv Chaudhuri
  9. M
    Markus W. Weissmann
  10. M
    Mehdi Dogguy
  11. N
    Niki Yoshiuchi
  12. P
    Pierre Chambart
  13. R
    Roman Vorobets
  14. S
    Stéphane Glondu
  15. S
    Sylvain Le Gall
  16. Y
    ygrek
  17. Z
    Zhenya Lykhovyd

Maintainers

  1. Y
    ygrek@autistici.org

Sources

ocaml-extunix-0.3.2.tar.gz
md5=c2706a62e14f64dbc347d986a38d7b1c
sha256=3ad5c6bfef5d87273f7ba91bf14c4cebee9171439cfacdb06b294427cf034bed
sha512=cccc4808a901284c26e6b268b8536d5dbfe24ccc83bf090fe38e20698647f054573fdfcd1c5709d3aedbe49c6bd45927b317e8b94bb1e8d91d6c22765915bbcb

doc/extunix/ExtUnixSpecific/HostEndian/index.html

Module ExtUnixSpecific.HostEndian

host endian functions

  • author Goswin von Brederlow
val unsafe_get_uint8 : string -> int -> int

unsafe_get_X str off extract integer of type X from string str starting at offset off. Unsigned types are 0 extended and signed types are sign extended to fill the ocaml type. Bounds checking is not performed. Use with caution and only when the program logic guarantees that the access is within bounds.

Note: The 31bit functions extract a 32bit integer and return it as ocaml int. On 32bit platforms this can overflow as ocaml integers are 31bit signed there. No error is reported if this occurs. Use with care. Note: The same applies to 63bit functions.

val unsafe_get_int8 : string -> int -> int
val unsafe_get_uint16 : string -> int -> int
val unsafe_get_int16 : string -> int -> int
val unsafe_get_uint31 : string -> int -> int
val unsafe_get_int31 : string -> int -> int
val unsafe_get_int32 : string -> int -> int32
val unsafe_get_uint63 : string -> int -> int
val unsafe_get_int63 : string -> int -> int
val unsafe_get_int64 : string -> int -> int64
val get_uint8 : string -> int -> int

get_X str off same as unsafe_get_X but with bounds checking.

val get_int8 : string -> int -> int
val get_uint16 : string -> int -> int
val get_int16 : string -> int -> int
val get_uint31 : string -> int -> int
val get_int31 : string -> int -> int
val get_int32 : string -> int -> int32
val get_uint63 : string -> int -> int
val get_int63 : string -> int -> int
val get_int64 : string -> int -> int64
val unsafe_set_uint8 : Bytes.t -> int -> int -> unit

unsafe_set_X buf off v stores the integer v as type X in the buffer buf starting at offset off. Bounds checking is not performed. Use with caution and only when the program logic guarantees that the access is within bounds.

Note: The 31bit functions store an ocaml int as 32bit integer. On 32bit platforms ocaml integers are 31bit signed and will be sign extended to 32bit first. Use with care. Note: The same applies to 63bit functions.

val unsafe_set_int8 : Bytes.t -> int -> int -> unit
val unsafe_set_uint16 : Bytes.t -> int -> int -> unit
val unsafe_set_int16 : Bytes.t -> int -> int -> unit
val unsafe_set_uint31 : Bytes.t -> int -> int -> unit
val unsafe_set_int31 : Bytes.t -> int -> int -> unit
val unsafe_set_int32 : Bytes.t -> int -> int32 -> unit
val unsafe_set_uint63 : Bytes.t -> int -> int -> unit
val unsafe_set_int63 : Bytes.t -> int -> int -> unit
val unsafe_set_int64 : Bytes.t -> int -> int64 -> unit
val set_uint8 : Bytes.t -> int -> int -> unit

set_X buf off v same as unsafe_set_X but with bounds checking.

val set_int8 : Bytes.t -> int -> int -> unit
val set_uint16 : Bytes.t -> int -> int -> unit
val set_int16 : Bytes.t -> int -> int -> unit
val set_uint31 : Bytes.t -> int -> int -> unit
val set_int31 : Bytes.t -> int -> int -> unit
val set_int32 : Bytes.t -> int -> int32 -> unit
val set_uint63 : Bytes.t -> int -> int -> unit
val set_int63 : Bytes.t -> int -> int -> unit
val set_int64 : Bytes.t -> int -> int64 -> unit