ehmry
/
preserves-nim
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Nim implementation of the Preserves data language
94 Commits 1 Branch 25 Tags 550 KiB
Nim 100%
Go to file
Emery Hemingway 29d7352a23 Assert upreservable pragma at runtime 
This makes the compiler less pedantic.
 		2021-10-25 21:36:57 +02:00
src Assert upreservable pragma at runtime 2021-10-25 21:36:57 +02:00
tests mapEmbeds for Preserve[void] to Preserve[E] 2021-10-25 21:36:45 +02:00
upstream@b2c3032e7a Schemas: use canonical meta-schema 2021-10-17 13:26:05 +02:00
.gitignore Schemas: use canonical meta-schema 2021-10-17 13:26:05 +02:00
.gitmodules Schemas: use canonical meta-schema 2021-10-17 13:26:05 +02:00
README.md Update documentation 2021-10-25 21:36:57 +02:00
UNLICENSE Unlicense 2021-08-31 17:00:00 +02:00
preserves.nimble Fix schema import, normalize version 2021-10-17 14:22:41 +02:00

README.md

Preserves

Nim implementation of the Preserves data language.

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 and fromPreserve 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.