bencoding: A library for encoding and decoding of BEncode data.
A library for encoding and decoding of BEncode data.
- Release notes
0.1.0.0: Initial version.
0.2.0.0: Added default decoders/encoders using GHC Generics.
[Skip to Readme]
| Versions | 0.1.0.0, 0.2.0.0, 0.2.1.0, 0.2.2.0, 0.3.0.0, 0.4.0.0, 0.4.0.1, 0.4.0.2, 0.4.1.0, 0.4.2.0, 0.4.2.1, 0.4.3.0, 0.4.4.0 (info) |
|---|---|
| Dependencies | attoparsec (>=0.10), base (==4.*), bencoding, bytestring (>=0.10.0.2), containers (>=0.4), deepseq (==1.3.*), ghc-prim, pretty, text (>=0.11) [details] |
| License | MIT |
| Copyright | (c) 2013, Sam T. |
| Author | Sam T. |
| Maintainer | Sam T. <pxqr.sta@gmail.com> |
| Category | Data |
| Home page | https://github.com/cobit/bencoding |
| Bug tracker | https://github.com/cobit/bencoding/issues |
| Source repo | head: git clone git://github.com/cobit/bencoding.git |
| Uploaded | by SamTruzjan at Tue Aug 27 19:26:56 UTC 2013 |
| Distributions | NixOS:0.4.4.0 |
| Executables | pp |
| Downloads | 5592 total (168 in the last 30 days) |
| Rating | (no votes yet) [estimated by rule of succession] |
| Your Rating | |
| Status | Docs uploaded by user Build status unknown [no reports yet] Hackage Matrix CI |
Downloads
- bencoding-0.2.0.0.tar.gz [browse] (Cabal source package)
- Package description (as included in the package)
Readme for bencoding-0.2.0.0
[back to package description]Synopsis
BEncode is JSON-like format used in bittorrent protocol but might be used anywhere else.
Description
This package implements fast seamless encoding/decoding to/from bencode format for many native datatypes. To achive more performance we use bytestring builders and hand optimized attoparsec parser so this library is considered as replacement for BEncode and AttoBencode packages.
Format
Bencode is pretty similar to JSON: it has dictionaries(JSON objects), lists(JSON arrays), strings and integers. However bencode has a few advantages:
- Compactness: no spaces in between any values — nor lists nor dicts nor anywhere else.
- Dictionaries always sorted lexicographically by the keys. This allow us to test data on equality without decoding from raw bytestring. Moreover this allow to hash encoded data (this property is heavily used by core bittorrent protocol).
- All strings prefixed with its length. This simplifies and speed up string parsing.
Hovewer there are some disadvantages comparing with JSON:
- Bencode is certainly less human readable.
- Bencode is rarely used, except bittorrent protocol of course.
Documentation
For documentation see package hackage page.
Build Status
Maintainer pxqr.sta@gmail.com
Feel free to report bugs and suggestions via issue tracker or the mail.