Erlang External Term Format (ETF) for Ruby
Ruby
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.coveralls.yml
.editorconfig
.gitignore
.ruby-gemset
.ruby-version
.travis.yml
.yardopts
CHANGELOG.md
Gemfile
LICENSE.txt
README.md
Rakefile
erlang-etf.gemspec

README.md

Erlang::ETF

Travis Coverage Status Gem Docs Inline docs

Erlang External Term Format (ETF) for Ruby.

Note: Please see the erlang-terms gem for more information about the Erlang-to-Ruby type mappings (for example, Erlang::Pid).

Installation

Add this line to your application's Gemfile:

gem 'erlang-etf', '~> 2.0'

And then execute:

$ bundle

Or install it yourself as:

$ gem install erlang-etf

Usage

Erlang.term_to_binary(term)

Erlang.term_to_binary(:atom)
# => "\x83s\x04atom"

Compression is optional and valid arguments are false, true, and integers 0-9.

Erlang.term_to_binary([1] * 100, compressed: true)
# => "\x83P\x00\x00\x00\xCEx\x9C\xCBa``HId\x1C\x1E0\v\x00\xE85'\x83"

Erlang.binary_to_term(binary)

Erlang.binary_to_term("\x83s\x04atom")
# => :atom

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/potatosalad/ruby-erlang-etf. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.