package faraday
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=141b4adb176b3f2bd264bd6c1d0d1ec44b492a0a7fa94915da368326759532ca
md5=77131b64c0a2ce43daa5a584a2be640a
README.md.html
Faraday
Faraday is a library for writing fast and memory-efficient serializers. Its core type and related operation gives the user fine-grained control over copying and allocation behavior while serializing user-defined types, and presents the output in a form that makes it possible to use vectorized write operations, such as the writev system call, or any other platform or application-specific output APIs.
Installation
Install the library and its depenencies via OPAM:
opam install faraday
Usage
Like its sister project Angstrom, Faraday is written with network protocols and serialization formats in mind. As such, its source distribution inclues implementations of various RFCs that are illustrative of real-world applications of the library. This includes a JSON serializer.
In addition, it's appropriate here to include a serializer for the simple arithmetic expression language described in Angstrom's README.
open Faraday
type 'a binop = [
| `Sub of 'a * 'a
| `Add of 'a * 'a
| `Div of 'a * 'a
| `Mul of 'a * 'a
]
;;
type t = [ `Num of int | t binop ]
let rec serialize ?(prec=0) t expr =
match expr with
| `Num n -> write_string t (Printf.sprintf "%d" n)
| #binop as binop ->
let prec', op, l, r =
match binop with
| `Sub(l, r) -> 2, '-', l, r
| `Add(l, r) -> 3, '+', l, r
| `Div(l, r) -> 4, '/', l, r
| `Mul(l, r) -> 5, '*', l, r
in
if prec' < prec then write_char t '(';
serialize t ~prec:prec' l;
write_char t op;
serialize t ~prec:prec' r;
if prec' < prec then write_char t ')'
let to_string expr =
let t = create 0x1000 in
serialize t expr;
serialize_to_string t
Development
To install development dependencies, pin the package from the root of the repository:
opam pin add -n faraday .
opam install --deps-only faraday
After this, you may install a development version of the library using the install command as usual.
For building and running the tests during development, you will need to install the alcotest
package and reconfigure the build process to enable tests:
opam install alcotest
./configure --enable-tests
make && make test
License
BSD3, see LICENSE file for its text.