package ctypes

  1. Overview
  2. Docs
Combinators for binding to C libraries without writing any C

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (38)

Authors

  1. J
    Jeremy Yallop

Maintainers

  1. J
    Jeremy Yallop <yallop@gmail.com>

Sources

0.23.0.tar.gz
sha256=cae47d815b27dd4c824a007f1145856044542fe2588d23a443ef4eefec360bf1
md5=b1af973ec9cf7867a63714e92df82f2a

doc/ctypes/Ctypes_static/index.html

Module Ctypes_staticSource

Sourcetype abstract_type = {
  1. aname : string;
  2. asize : int;
  3. aalignment : int;
}
Sourcetype _ ocaml_type =
  1. | String : string ocaml_type
  2. | Bytes : bytes ocaml_type
  3. | FloatArray : float array ocaml_type
Sourcetype incomplete_size = {
  1. mutable isize : int;
}
Sourcetype structured_spec = {
  1. size : int;
  2. align : int;
}
Sourcetype 'a structspec =
  1. | Incomplete of incomplete_size
  2. | Complete of structured_spec
Sourcetype qualifier =
  1. | Const
  2. | Volatile
Sourcetype _ typ =
  1. | Void : unit typ
  2. | Primitive : 'a Ctypes_primitive_types.prim -> 'a typ
  3. | Pointer : 'a typ -> 'a ptr typ
  4. | Funptr : 'a fn -> 'a static_funptr typ
  5. | Struct : 'a structure_type -> 'a structure typ
  6. | Union : 'a union_type -> 'a union typ
  7. | Abstract : abstract_type -> 'a abstract typ
  8. | View : ('a, 'b) view -> 'a typ
  9. | Qualified : qualifier * 'a typ -> 'a typ
  10. | Array : 'a typ * int -> 'a carray typ
  11. | Bigarray : (_, 'a, _) Ctypes_bigarray.t -> 'a typ
  12. | OCaml : 'a ocaml_type -> 'a ocaml typ
Sourceand 'a carray = {
  1. astart : 'a ptr;
  2. alength : int;
}
Sourceand ('a, 'kind) structured = {
  1. structured : ('a, 'kind) structured ptr;
}
Sourceand 'a union = ('a, [ `Union ]) structured
Sourceand 'a structure = ('a, [ `Struct ]) structured
Sourceand 'a abstract = ('a, [ `Abstract ]) structured
Sourceand (_, _) pointer =
  1. | CPointer : (Obj.t option, 'a typ) Ctypes_ptr.Fat.t -> ('a, [ `C ]) pointer
  2. | OCamlRef : int * 'a * 'a ocaml_type -> ('a, [ `OCaml ]) pointer
Sourceand 'a ptr = ('a, [ `C ]) pointer
Sourceand 'a ocaml = ('a, [ `OCaml ]) pointer
Sourceand 'a static_funptr =
  1. | Static_funptr : (Obj.t option, 'a fn) Ctypes_ptr.Fat.t -> 'a static_funptr
Sourceand ('a, 'b) view = {
  1. read : 'b -> 'a;
  2. write : 'a -> 'b;
  3. format_typ : ((Format.formatter -> unit) -> Format.formatter -> unit) option;
  4. format : (Format.formatter -> 'a -> unit) option;
  5. ty : 'b typ;
}
Sourceand ('a, 's) field = {
  1. ftype : 'a typ;
  2. foffset : int;
  3. fname : string;
}
Sourceand 'a structure_type = {
  1. tag : string;
  2. mutable spec : 'a structspec;
  3. mutable fields : 'a structure boxed_field list;
}
Sourceand 'a union_type = {
  1. utag : string;
  2. mutable uspec : structured_spec option;
  3. mutable ufields : 'a union boxed_field list;
}
Sourceand 's boxed_field =
  1. | BoxedField : ('a, 's) field -> 's boxed_field
Sourceand _ fn =
  1. | Returns : 'a typ -> 'a fn
  2. | Function : 'a typ * 'b fn -> ('a -> 'b) fn
Sourcetype _ bigarray_class =
  1. | Genarray : < element : 'a ; layout : 'l ; dims : int array ; ba_repr : 'b ; bigarray : ('a, 'b, 'l) Bigarray_compat.Genarray.t ; carray : 'a carray > bigarray_class
  2. | Array1 : < element : 'a ; layout : 'l ; dims : int ; ba_repr : 'b ; bigarray : ('a, 'b, 'l) Bigarray_compat.Array1.t ; carray : 'a carray > bigarray_class
  3. | Array2 : < element : 'a ; layout : 'l ; dims : int * int ; ba_repr : 'b ; bigarray : ('a, 'b, 'l) Bigarray_compat.Array2.t ; carray : 'a carray carray > bigarray_class
  4. | Array3 : < element : 'a ; layout : 'l ; dims : int * int * int ; ba_repr : 'b ; bigarray : ('a, 'b, 'l) Bigarray_compat.Array3.t ; carray : 'a carray carray carray > bigarray_class
Sourcetype boxed_typ =
  1. | BoxedType : 'a typ -> boxed_typ
Sourceval sizeof : 'a typ -> int
Sourceval alignment : 'a typ -> int
Sourceval passable : 'a typ -> bool
Sourceval ocaml_value : 'a typ -> bool
Sourceval has_ocaml_argument : 'a fn -> bool
Sourceval void : unit typ
Sourceval char : char typ
Sourceval schar : int typ
Sourceval float : float typ
Sourceval double : float typ
Sourceval ldouble : LDouble.t typ
Sourceval complex32 : Complex.t typ
Sourceval complex64 : Complex.t typ
Sourceval complexld : ComplexL.t typ
Sourceval short : int typ
Sourceval int : int typ
Sourceval nativeint : nativeint typ
Sourceval int8_t : int typ
Sourceval int16_t : int typ
Sourceval camlint : int typ
Sourceval bool : bool typ
Sourceval array : int -> 'a typ -> 'a carray typ
Sourceval ocaml_string : string ocaml typ
Sourceval ocaml_bytes : bytes ocaml typ
Sourceval ocaml_float_array : float array ocaml typ
Sourceval ptr : 'a typ -> 'a ptr typ
Sourceval (@->) : 'a typ -> 'b fn -> ('a -> 'b) fn
Sourceval abstract : name:string -> size:int -> alignment:int -> 'a abstract typ
Sourceval view : ?format_typ:((Format.formatter -> unit) -> Format.formatter -> unit) -> ?format:(Format.formatter -> 'b -> unit) -> read:('a -> 'b) -> write:('b -> 'a) -> 'a typ -> 'b typ
Sourceval typedef : 'a typ -> string -> 'a typ
Sourceval bigarray : < ba_repr : 'c ; bigarray : 'd ; carray : 'e ; dims : 'b ; layout : Bigarray_compat.c_layout ; element : 'a > bigarray_class -> 'b -> ('a, 'c) Bigarray_compat.kind -> 'd typ
Sourceval fortran_bigarray : < ba_repr : 'c ; bigarray : 'd ; carray : 'e ; dims : 'b ; layout : Bigarray_compat.fortran_layout ; element : 'a > bigarray_class -> 'b -> ('a, 'c) Bigarray_compat.kind -> 'd typ
Sourceval returning : 'a typ -> 'a fn
Sourceval static_funptr : 'a fn -> 'a static_funptr typ
Sourceval structure : string -> 'a structure typ
Sourceval union : string -> 'a union typ
Sourceval offsetof : ('a, 'b) field -> int
Sourceval field_type : ('a, 'b) field -> 'a typ
Sourceval field_name : ('a, 'b) field -> string
Sourceval const : 'a typ -> 'a typ
Sourceval volatile : 'a typ -> 'a typ
Sourceexception IncompleteType
Sourceexception ModifyingSealedType of string
Sourceexception Unsupported of string
Sourceval unsupported : ('a, unit, string, _) format4 -> 'a
Sourcetype arithmetic =
  1. | Int8
  2. | Int16
  3. | Int32
  4. | Int64
  5. | Uint8
  6. | Uint16
  7. | Uint32
  8. | Uint64
  9. | Float
  10. | Double