capnp: Cap'n Proto for Haskell
A native Haskell implementation of the Cap'N Proto cerialization format and RPC protocol.
The library implements serialization and level 1 RPC.
The Capnp.Tutorial module is the best place to start reading; the reference documentation can seem bewildering without that context.
[Skip to Readme]
Modules
[Index] [Quick Jump]
- Capnp
- Data
Downloads
- capnp-0.18.0.0.tar.gz [browse] (Cabal source package)
- Package description (as included in the package)
| Versions [RSS] | 0.1.0.0, 0.2.0.0, 0.3.0.0, 0.4.0.0, 0.5.0.0, 0.6.0.0, 0.6.0.1, 0.6.0.2, 0.6.0.3, 0.7.0.0, 0.8.0.0, 0.9.0.0, 0.10.0.0, 0.10.0.1, 0.11.0.0, 0.12.0.0, 0.12.1.0, 0.13.0.0, 0.14.0.0, 0.15.0.0, 0.16.0.0, 0.17.0.0, 0.18.0.0 |
|---|---|
| Change log | CHANGELOG.md |
| Dependencies | async (>=2.2.1 && <2.3), base (>=4.14 && <5), bifunctors (>=5.5.8 && <5.7), bytes (>=0.15.4 && <0.18), bytestring (>=0.10 && <0.12), capnp, containers (>=0.5.9 && <0.7), data-default (>=0.7.1 && <0.8), data-default-instances-vector (>=0.0.1 && <0.1), directory (>=1.3.0 && <1.4), exceptions (>=0.10.0 && <0.11), filepath (>=1.4.2 && <1.5), focus (>=1.0.1 && <1.1), ghc-prim (>=0.6.1 && <0.11), hashable (>=1.2.7 && <1.5), lifetimes (>=0.2 && <0.3), list-t (>=1.0.2 && <1.1), monad-stm (>=0.1 && <0.2), mtl (>=2.2.2 && <2.4), network (>=3 && <3.2), network-simple (>=0.4 && <0.5), pretty-show (>=1.9.5 && <1.11), primitive (>=0.6.3 && <0.9), safe-exceptions (>=0.1.7 && <0.2), stm (>=2.5.0 && <2.6), stm-containers (>=1.1.0 && <1.3), supervisors (>=0.2.1 && <0.3), template-haskell (>=2.18 && <2.21), text (>=1.2 && <2.1), transformers (>=0.5.2 && <0.7), vector (>=0.12.0 && <0.14), wl-pprint-text (>=1.2 && <1.3) [details] |
| License | MIT |
| Copyright | 2016-2023 haskell-capnp contributors (see CONTRIBUTORS file). |
| Author | Ian Denhardt |
| Maintainer | ian@zenhack.net |
| Category | Data, Serialization, Network, Rpc |
| Home page | https://codeberg.org/zenhack/haskell-capnp |
| Bug tracker | https://codeberg.org/zenhack/haskell-capnp/issues |
| Source repo | head: git clone https://codeberg.org/zenhack/haskell-capnp.git -b master |
| Uploaded | by isd at 2023-06-23T00:07:19Z |
| Distributions | |
| Executables | capnpc-haskell |
| Downloads | 6020 total (68 in the last 30 days) |
| Rating | (no votes yet) [estimated by Bayesian average] |
| Your Rating | |
| Status | Docs available [build log] Last success reported on 2023-06-23 [all 1 reports] |
Readme for capnp-0.18.0.0
[back to package description]
A Haskell library for the Cap'N Proto Cerialization and RPC protocol.
Note, this project's official home is on codeberg; if you're viewing this elsewhere, this is a mirror. For trivial changes we'll still accept patches here, but please file issues and submit more substantial changes via codeberg.
Getting Started
There is a module Capnp.Tutorial which contains an introduction
to the library; users are strongly encouraged to read this first, as
the reference documentation can be bewildering without that context.
Status
Serialization support works, with some limitations:
- We do not support defining custom default values for fields of pointer type; see (#28).
- We currently do not correctly handle decoding lists of structs from non-composite lists (#27). This means that, contrary to the protocol evolution rules, it is not safe to change a field from type List(T) (where T is any non-struct type) to a list of a struct type.
Level 1 RPC support is implemented and usable, though it should be considered alpha quality for now. Specific things to be aware of:
- The implementation is not robust against resource exhaustion attacks; for now users are strongly discouraged from using it to do RPC with untrusted peers.
The API is considered unstable. It will likely see changes, for the sake of polish, consistency, etc. as well as to improve performance and accommodate more features as we add them.