https://github.com/dbuenzli/jsonm

Non-blocking streaming JSON codec for OCaml
https://github.com/dbuenzli/jsonm

Last synced: 19 days ago
JSON representation

Non-blocking streaming JSON codec for OCaml

• Host: GitHub
• URL: https://github.com/dbuenzli/jsonm
• Owner: dbuenzli
• License: isc
• Created: 2013-02-15T10:36:19.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2023-03-07T14:43:11.000Z (over 1 year ago)
• Last Synced: 2024-05-01T20:44:56.919Z (7 months ago)
• Language: OCaml
• Homepage: http://erratique.ch/software/jsonm
• Size: 101 KB
• Stars: 46
• Watchers: 6
• Forks: 9
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-multicore-ocaml - jsonm

README

        
Jsonm — Non-blocking streaming JSON codec for OCaml

-------------------------------------------------------------------------------

%%VERSION%%

Jsonm is a non-blocking streaming codec to decode and encode the JSON

data format. It can process JSON text without blocking on IO and

without a complete in-memory representation of the data.

The alternative "uncut" codec also processes whitespace and

(non-standard) JSON with JavaScript comments.

Jsonm is made of a single module and depends on [Uutf][uutf]. It is distributed

under the ISC license.

[uutf]: http://erratique.ch/software/uutf

Home page: http://erratique.ch/software/jsonm  

Contact: Daniel Bünzli ``

## Installation

Jsonm can be installed with `opam`:

    opam install jsonm

If you don't use `opam` consult the [`opam`](opam) file for build

instructions.

## Documentation

The documentation and API reference is automatically generated by

`ocamldoc` from the interfaces. It can be consulted [online][doc]

and there is a generated version in the `doc` directory of the

distribution.

[doc]: http://erratique.ch/software/jsonm/doc/Jsonm

## Sample programs

If you installed jsonm with `opam`, it installed the `jsontrip` binary

which, among other things, reads JSON on `stdin` and rewrites it on

`stdout`; invoke with `-help` for more information. Sample code is

located in the directory `opam config var jsonm:doc`.

In the distribution sample programs are located in the `test`

directory of the distribution. They can be built with:

    ocamlbuild -use-ocamlfind test/tests.otarget

The resulting binaries are in `_build/test`.