ProductPromotion
Logo

Elixir

made by https://0x3d.site

GitHub - gausby/bencode: A bencode encoder and decoder written in Elixir
A bencode encoder and decoder written in Elixir. Contribute to gausby/bencode development by creating an account on GitHub.
Visit Site

GitHub - gausby/bencode: A bencode encoder and decoder written in Elixir

GitHub - gausby/bencode: A bencode encoder and decoder written in Elixir

Bencode

Hex.pm Hex version

A complete and correct Bencode encoder and decoder written in pure Elixir.

The encoder is implemented as a protocol, allowing implementations for custom structs.

The decoder should handle malformed data, either by raising an error, or returning an 2-tuple with status, both containing detailed information about the error. The decoder is also capable of calculating the hash of the info dictionary.

API

  • Bencode.encode/1 will encode a given data structure to the b-code representation and return a {:ok, data}-tuple on success, or an {:error, reason}-tuple if the data was invalid.

  • Bencode.encode!/1 will encode a given data structure to the b-code representation; it will raise an error if the given input is invalid.

  • Bencode.decode/1 will decode a b-code encoded string and return a 2-tuple; containing the status (:ok) and its Elixir data structure representation. Should the data be invalid a 2-tuple will get returned with {:error, reason}

  • Bencode.decode!/1 will decode a b-code encoded string and return the decoded result as a Elixir data structure; if the input is invalid an it will raise with the reason.

  • Bencode.decode_with_info_hash/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. {:error, reason} will get returned if the input data was invalid b-code.

  • Bencode.decode_with_info_hash!/1 will do the same as the Bencode.decode_with_info_hash/1 function, but will raise if the given input is malformed.

Installation

Bencode is available in Hex, and can be installed by adding it to the list of dependencies in mix.exs:

  def deps do
    [{:bencode, "~> 0.3.0"}]
  end

Notice that there are other bencode implementations on hex. Please check them out:

Bento is the fastest option, but Bencode has arguably better error reporting during decoding.

Thanks

Thanks to the following for their contributions to the project:

License

Copyright 2016 Martin Gausby

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Articles
to learn more about the elixir concepts.

Resources
which are currently available to browse on.

mail [email protected] to add your project or resources here 🔥.

FAQ's
to know more about the topic.

mail [email protected] to add your project or resources here 🔥.

Queries
or most google FAQ's about Elixir.

mail [email protected] to add more queries here 🔍.

More Sites
to check out once you're finished browsing here.

0x3d
https://www.0x3d.site/
0x3d is designed for aggregating information.
NodeJS
https://nodejs.0x3d.site/
NodeJS Online Directory
Cross Platform
https://cross-platform.0x3d.site/
Cross Platform Online Directory
Open Source
https://open-source.0x3d.site/
Open Source Online Directory
Analytics
https://analytics.0x3d.site/
Analytics Online Directory
JavaScript
https://javascript.0x3d.site/
JavaScript Online Directory
GoLang
https://golang.0x3d.site/
GoLang Online Directory
Python
https://python.0x3d.site/
Python Online Directory
Swift
https://swift.0x3d.site/
Swift Online Directory
Rust
https://rust.0x3d.site/
Rust Online Directory
Scala
https://scala.0x3d.site/
Scala Online Directory
Ruby
https://ruby.0x3d.site/
Ruby Online Directory
Clojure
https://clojure.0x3d.site/
Clojure Online Directory
Elixir
https://elixir.0x3d.site/
Elixir Online Directory
Elm
https://elm.0x3d.site/
Elm Online Directory
Lua
https://lua.0x3d.site/
Lua Online Directory
C Programming
https://c-programming.0x3d.site/
C Programming Online Directory
C++ Programming
https://cpp-programming.0x3d.site/
C++ Programming Online Directory
R Programming
https://r-programming.0x3d.site/
R Programming Online Directory
Perl
https://perl.0x3d.site/
Perl Online Directory
Java
https://java.0x3d.site/
Java Online Directory
Kotlin
https://kotlin.0x3d.site/
Kotlin Online Directory
PHP
https://php.0x3d.site/
PHP Online Directory
React JS
https://react.0x3d.site/
React JS Online Directory
Angular
https://angular.0x3d.site/
Angular JS Online Directory