Skip to content

Semi-automatic documentation generation for serialization formats

License

Notifications You must be signed in to change notification settings

input-output-hk/serdoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

serdoc

Unified serialization with semi-automatic documentation

Introduction

SerDoc provides:

  • A unified interface for serialization formats ("codecs"), in the form of a 'Serializable' typeclass.
  • A mini-EDSL (FieldInfo) for describing serialization formats as first-class data structures, and a typeclass (HasInfo) to link them to codecs and serializable Haskell types.
  • Building blocks and utility code for implementing Codec, Serializable, and HasInfo for existing or new serialization formats.

It also includes an implementation of these typeclasses for the binary package.

Components

SerDoc is split up into two sub-projects:

  • serdoc-core, which provides the typeclasses and building blocks
  • serdoc-binary, which provides instances for binary

See their individual README.md files for details.

About

Semi-automatic documentation generation for serialization formats

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published