package encore
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=aa0ea179205ce8e49f6fbbd9c448b8aeb2a1fa7c7e7df9ec09f56f855477c98d
sha512=1d45278af321026902554d929cf97820637bae9042bcea3dfb0b017993ca150685a1cc1c4febd10f83de214a382c50e398b365c35dce8e5add8e504f4a05dabb
Description
Encore is a little library to provide an interface to generate an angstrom decoder and an internal encoder from a shared description. The goal is to ensure a dual isomorphism between them.
Published: 04 Mar 2025
README
Encore
serializer / deserializer
The goal of encore is to provide a way to express a format. From it, the user is able to make an angstrom's parser or a lavoisier's encoder. It wants to ensure isomorphism:
type v
let t : v Encore.t = ...
let decoder = Encore.to_angstrom t
let encoder = Encore.to_lavoisier t
let assert random_v =
let str = Encore.Lavoisier.emit_string random_v encoder in
let v' = Angstrom.parse_string decoder str in
assert (v = v')
How to install?
encore requires OCaml 4.07 and it is available with OPAM:
$ opam install encore
It can be compiled with js_of_ocaml.
Documentation
A documentation is available here to explain how to properly use encore. Some examples of encore exists into ocaml-git.
Inspirations
This project is inspired by the finale project which is focused on a pretty-printer at the end. Encore is close to provide a low-level encoder like faraday than a generator of a pretty-printer.