ehmry
/
preserves-nim
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Nim implementation of the Preserves data language
201 Commits 1 Branch 25 Tags 557 KiB
Nim 100%
Go to file
Emery Hemingway b9d8275624 schema: emit "tuple[]" for literal object fields 2023-05-04 10:55:09 +01:00
src schema: emit "tuple[]" for literal object fields 2023-05-04 10:55:09 +01:00
tests Rewrite tupfiles 2022-12-11 19:21:17 -06:00
.gitignore Schemas: use canonical meta-schema 2021-10-17 13:26:05 +02:00
.gitmodules Remove submodule 2022-02-19 10:33:16 -06:00
README.md Add note on syndicate-nim to README 2023-04-05 20:05:42 -05:00
Tuprules.tup Manage Nimble packages with Tup 2023-04-03 17:04:57 -05:00
UNLICENSE Unlicense 2021-08-31 17:00:00 +02:00
depends.tup Manage Nimble packages with Tup 2023-04-03 17:04:57 -05:00
preserves.nimble schema: emit "tuple[]" for literal object fields 2023-05-04 10:55:09 +01:00
schema.bin Remove submodule 2022-02-19 10:33:16 -06:00
schema.prs Remove submodule 2022-02-19 10:33:16 -06:00

README.md

Preserves

Nim implementation of the Preserves data language.

If you don't know why you need Preserves, see the Syndicate library.

Library

To parse or produce Preserves one should write a schema and generate a Nim module using the preserves_schema_nim utility. This module will contain Nim types corresponding to schema definitions. The toPreserve andfromPreserve routines will convert Nim types to and from Preserves. The decodePreserves, parsePreserves, encode, and $ routines will convert Preserve objects to and from binary and textual encoding.

To debug the toPreserves and fromPreserves routines compile with -d:tracePreserves.

Utilities

  • preserves_schema_nim
  • preserves_encode
  • preserves_decode
  • preserves_from_json
  • preserves_to_json

Installation

preserves_encode is a multi-call binary that implements preserves_encode, preserves_decode, preserves_from_json, and preserves_to_json, so the appropriate symlinks should be created during packaging.