package serde_json

  1. Overview
  2. Docs
JSON format support for Serde

Install

Dune Dependency

Authors

Maintainers

Sources

serde-0.0.2.tbz
sha256=0766b13f1e9421f98fab8efc5d43657229f3b3bc13ca4722086da634fe076ca4
sha512=1023dcd53c4b69032f466b338e2f0146ee3443b2ec4ce8db2d1f226e1409d81a3da3767ac73e9e047fd61b904a829ff841c26317c8ea050351ba6f70ab4158c4

Description

Published: 12 Apr 2024

README

serde.ml

A serialization framework for OCaml inspired by serde-rs.

The main goals for serde.ml are:

  • Serialization -- take arbitary data structures from the user and turn them into specific formats with maximum efficiency.

  • Deserialization -- read arbitrary data that you parse into data structures of the user's choice with maximum efficiency.

type rank = Captain | Chief_petty_officer [@@deriving serialize, deserialize]
type t = { name : string; rank : rank } [@@deriving serialize, deserialize]

let obrien = { name = "Miles O'Brien"; rank = Chief_petty_officer }
let sisko = { name = "Benjamin Sisko"; rank = Captain }

> Serde_json.to_string_pretty (serialize_t) obrien
Ok "{ \"name\": \"Miles O'Brien\", \"rank\": \"Chief_petty_officer\" }"

> Serde_json.of_string (deserialize_t) "{ \"name\": \"Miles O'Brien\", \"rank\": \"Chief_petty_officer\" }"
Ok {name = "Miles O'Brien"; rank = Chief_petty_officer}

> Serde_sexpr.to_string_pretty (serialize_t) obrien;;
Ok "(\"Miles O'Brien\" :Chief_petty_officer)"

> Serde_sexpr.of_string (deserialize_t) "(\"Miles O'Brien\" :Chief_petty_officer)";;
Ok {name = "Miles O'Brien"; rank = Chief_petty_officer}

Installation

To install serde from opam, use:

; opam install serde serde_derive serde_json -y

To install serde from sources, use:

; opam pin serde.0.0.2 git+https://github.com/serde-ml/serde -y
; opam pin serde_derive.0.0.2 git+https://github.com/serde-ml/serde -y
; opam pin serde_json.0.0.2 git+https://github.com/serde-ml/serde -y

Usage

To derive deserialize/serialize functions for your data types, make sure to

  • include the serde library

  • include (preprocess (pps serde_derive)) in your library config

  • include any of the formats you want to use (like serde_json)

Now you can add @@deriving annotations to your types:

type rank = Captain | Chief_petty_officer [@@deriving serialize, deserialize]
type t = { name : string; rank : rank } [@@deriving serialize, deserialize]

And use them with the formats:

Serde_json.to_string serialize_rank { name = "Benjamin Sisko"; rank = Captain }

Contributing

Check the CONTRIBUTING.md for a small guide on how to implement new data formats.

Dependencies (6)

  1. dune >= "3.12"
  2. yojson >= "2.1.0"
  3. serde = version
  4. rio >= "0.0.8"
  5. ppx_inline_test >= "v0.16.0"
  6. ocaml >= "5.1.1"

Dev Dependencies (1)

  1. odoc with-doc

Used by (2)

  1. serde_derive >= "0.0.2"
  2. spotify_ml

Conflicts

None

OCaml

Innovation. Community. Security.