Reference

Every module’s interface, generated by odoc from its .mli, where each function says what it does, what it refuses and when it raises.

The packages

The two are released together, at one version. A dune file names a library as it is installed (ppx_wiretype); OCaml code names it as a module (Wiretype).

Package	Libraries	What it is
wiretype	wiretype	descriptions: reading, writing, bounds, kinds, schemas; links Ptime, Mtime and Uuidm alone
ppx_wiretype	ppx_wiretype	[@@deriving wiretype], which writes a type’s description

wiretype

• Wiretype – the combinators, the kinds, decode and encode. Its modules: Object, Tuple and Value.
• Wiretype.Problem – what a reader is told: a path, a code and a sentence.
• Wiretype.Unwritable – what a writer is told.
• Wiretype.Schema – one walk into a schema, printed as JSON Schema, Zod and Melange.
• Wiretype.Shape – the GADT a description is.
• Wiretype.Text – JSON’s spellings of a number and a string.

ppx_wiretype

• Ppx_wiretype – [@@deriving wiretype]: every type it reads, and every attribute.