The bencoding package

[Tags:benchmark, bsd3, library, test]

A library for encoding and decoding of BEncode data.

Release notes

[Skip to Readme]

Properties

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 (info)
Dependencies attoparsec (>=0.10), base (==4.*), bytestring (>=0.10.0.2), containers (>=0.4), deepseq (==1.3.*), ghc-prim, pretty, text (>=0.11) [details]
License BSD3
Copyright (c) 2013, Sam Truzjan
Author Sam Truzjan
Maintainer Sam Truzjan <pxqr.sta@gmail.com>
Stability Experimental
Category Data
Home page https://github.com/cobit/bencoding
Bug tracker https://github.com/cobit/bencoding/issues
Source repository head: git clone git://github.com/cobit/bencoding.git -b master
this: git clone git://github.com/cobit/bencoding.git -b master(tag v0.2.2.0)
Uploaded Sat Sep 28 00:53:45 UTC 2013 by SamTruzjan
Distributions NixOS:0.4.3.0
Downloads 3131 total (39 in the last 30 days)
Votes
0 []
Status Docs available [build log]
Successful builds reported [all 1 reports]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for bencoding

Readme for bencoding-0.2.2.0

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

Build Status

Maintainer pxqr.sta@gmail.com

Feel free to report bugs and suggestions via issue tracker or the mail.