bencoding: A library for encoding and decoding of BEncode data.

[ bsd3, data, library ] [ Propose Tags ]

A library for fast and easy encoding and decoding of BEncode data.


[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)
Change log ChangeLog
Dependencies attoparsec (>=0.10), base (>=4.4 && <5), bytestring (>=0.10), deepseq (>=1.3), ghc-prim, integer-gmp, mtl, pretty, semigroups (>=0.9 && <0.19), text (>=0.11) [details]
License BSD-3-Clause
Copyright (c) 2013-2018, Sam Truzjan (c) 2018 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.4.0)
Uploaded by SergeyVinokurov at Sat Aug 18 12:15:36 UTC 2018
Distributions NixOS:0.4.4.0
Downloads 5821 total (43 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2018-08-18 [all 1 reports]
Hackage Matrix CI

Modules

[Index] [Quick Jump]

Flags

NameDescriptionDefaultType
dev

Enable development options

DisabledManual

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for bencoding-0.4.4.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 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

Build Status

Maintainer serg.foo@gmail.com

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