serdoc-binary: `binary` backend for `serdoc`

[ apache, data, library ] [ Propose Tags ]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.0.0
Change log CHANGELOG.md
Dependencies base (>=4.14.0.0 && <5), binary (>=0.8.0.0 && <0.11), bytestring (>=0.11 && <0.13), serdoc-core (>=0.1.0.0 && <0.2) [details]
License Apache-2.0
Copyright 2023 IO Global
Author Tobias Dammers
Maintainer tobias@well-typed.com
Category Data
Uploaded by TobiasDammers at 2024-02-06T08:42:48Z
Distributions
Downloads 34 total (5 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2024-02-06 [all 1 reports]

Readme for serdoc-binary-0.1.0.0

[back to package description]

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 (this library), which provides instances for binary