Packages

bencode

0.0.1
0.3.2 0.3.1 0.3.0 0.2.0 0.1.2 0.1.1 0.1.0 0.0.2 0.0.1

A complete and correct Bencode encoder and decoder written in pure Elixir. The decoder will return the info hash with along with the decoded data, and the encoder is implemented as a protocol, allowing any data structure to be bcode encoded.

Current section

Files

Jump to
Readme
9 Versions
1 Dependency
Dependants
Files
Activity
bencode README.md
Raw

README.md 

# Bencode



A Bencode encoder and decoder for Elixir. The decoder will return the checksum value of the `info` dictionary, if an `info` dictionary was found in the input.



## API



* `Bencode.encode/1` will encode a given data structure to the b-code representation.



* `Bencode.decode/1` will decode a b-code encoded string and return a 3-tuple; containing the status (`:ok`), its Elixir data structure representation along with the checksum of the info dictionary. If no info-dictionary was found the last value will be `nil`.





## Installation



If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:



  1. Add bencode to your list of dependencies in `mix.exs`:



        def deps do

          [{:bencode, "~> 0.0.1"}]

        end



  2. Ensure bencode is started before your application:



        def application do

          [applications: [:bencode]]

        end