@@ -12,6 +12,8 @@ This repository provides several packages that can be installed via the
12
12
[ OPAM] ( https://opam.ocaml.org ) package manager:
13
13
14
14
- ` cstruct ` : the core Cstruct library
15
+ - ` cstruct-sexp ` : serialisers into s-expression format of Cstructs
16
+ - ` cstruct-unix ` : provide Unix variations of the read/write functions using file descriptors
15
17
- ` cstruct-async ` : provide [ Async] ( https://github.com/janestreet/async ) Pipe and Bigstring support
16
18
- ` cstruct-lwt ` : provide [ Lwt] ( https://ocsigen.org/lwt ) variants of read/write functions
17
19
- ` ppx_cstruct ` : a [ PPX] ( https://caml.inria.fr/pub/docs/manual-ocaml/extn.html#sec248 ) syntax extension (see below)
@@ -20,7 +22,7 @@ The libraries depend on OCaml version 4.02.3 and later, since it provides a
20
22
[ ppx] ( http://whitequark.org/blog/2014/04/16/a-guide-to-extension-points-in-ocaml/ )
21
23
extension point. The old
22
24
[ camlp4] ( http://caml.inria.fr/pub/docs/manual-camlp4/manual002.html )
23
- syntax extension is nolonger available; the last version which contained it
25
+ syntax extension is nolonger available; the last cstruct release which contained it
24
26
was v1.9.0.
25
27
26
28
### Local development
@@ -192,6 +194,10 @@ type foo64 =
192
194
And ` sexp_of_foo64 ` and ` foo64_of_sexp ` functions will also be available.
193
195
The representation of the Sexp is the string representation of the enum.
194
196
197
+ If you do use the sexp decorator, then you will also need to add
198
+ ` sexplib ` to the dependency list for your package (both in the
199
+ ` dune ` file and the ` opam ` file).
200
+
195
201
Please see the ` ppx_test/ ` directory for more in-depth examples.
196
202
197
203
[ ![ Build Status] ( https://travis-ci.org/mirage/ocaml-cstruct.svg )] ( https://travis-ci.org/mirage/ocaml-cstruct )
0 commit comments