bencoding: A library for encoding and decoding of BEncode data.
Modules
[Index] [Quick Jump]
Flags
Manual Flags
| Name | Description | Default |
|---|---|---|
| dev | Enable development options | Disabled |
| benchmark-atto-bencode | Compare performance of this package against AttoBencode in benchmarks | Disabled |
Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info
Downloads
- bencoding-0.4.5.6.tar.gz [browse] (Cabal source package)
- Package description (as included in the package)
Maintainer's Corner
For package maintainers and hackage trustees
Candidates
| Versions [RSS] | 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, 0.4.5.0, 0.4.5.1, 0.4.5.2, 0.4.5.3, 0.4.5.4, 0.4.5.5, 0.4.5.6 (info) |
|---|---|
| Change log | Changelog.md |
| Dependencies | attoparsec (>=0.10), base (>=4.9 && <5), bytestring (>=0.10), deepseq (>=1.3), ghc-prim, integer-gmp, mtl, pretty, semigroups (>=0.9), text (>=0.11) [details] |
| Tested with | ghc ==8.0, ghc ==8.2, ghc ==8.4, ghc ==8.6, ghc ==8.8, ghc ==8.10, ghc ==9.0, ghc ==9.2, ghc ==9.4, ghc ==9.6, ghc ==9.8, ghc ==9.10 |
| License | BSD-3-Clause |
| Copyright | (c) 2013-2018, Sam Truzjan (c) 2018-2024 Sergey Vinokurov |
| Author | Sam Truzjan |
| Maintainer | Sergey Vinokurov <serg.foo@gmail.com> |
| Category | Data |
| Home page | https://github.com/sergv/bencoding |
| Bug tracker | https://github.com/sergv/bencoding/issues |
| Source repo | head: git clone https://github.com/sergv/bencoding.git -b master this: git clone https://github.com/sergv/bencoding.git -b master(tag v0.4.5.6) |
| Uploaded | by SergeyVinokurov at 2024-12-11T23:45:27Z |
| Distributions | LTSHaskell:0.4.5.6, NixOS:0.4.5.5, Stackage:0.4.5.6 |
| Reverse Dependencies | 5 direct, 0 indirect [details] |
| Downloads | 14757 total (56 in the last 30 days) |
| Rating | 2.0 (votes: 1) [estimated by Bayesian average] |
| Your Rating | |
| Status | Docs available [build log] Last success reported on 2024-12-12 [all 1 reports] |
Readme for bencoding-0.4.5.6
[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 achieve 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 serg.foo@gmail.com
Feel free to report bugs and suggestions via issue tracker or the mail.