codec-beam: Erlang VM byte code assembler

[ bsd3, codec, language, library ] [ Propose Tags ]

Erlang VM byte code assembler.

[Skip to Readme]
Versions [faq] 0.1.0, 0.1.1, 0.2.0
Dependencies base (>=4.8 && <5), bytestring (>=0.10.6), containers (>=, text (>=1.2.2), zlib (>= [details]
License BSD-3-Clause
Category Language, Codec
Home page
Bug tracker
Source repo head: git clone git://
Uploaded by hkgumbs at Fri Apr 6 21:51:32 UTC 2018
Distributions LTSHaskell:0.2.0, NixOS:0.2.0, Stackage:0.2.0
Downloads 494 total (19 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2018-04-14 [all 1 reports]




Maintainer's Corner

For package maintainers and hackage trustees

Readme for codec-beam-0.1.1

[back to package description]

Build Status Erlant/OTP Release

NOTE: Participation is encouraged! Make issues, ask questions, submit pull requests (even if it’s your first time contributing to open-source — you’ll get lots of help), and give feedback!

Erlang VM byte code assembler for implementing compile-to-beam languages. The goal is to a provide delightful API for generating BEAM instructions from pure Haskell.


This example writes a simple module to a file:

{-# LANGUAGE OverloadedStrings #-}
module Main where
import qualified Data.ByteString.Lazy as LBS

import Codec.Beam.Instructions (func_info, label, move, return')
import qualified Codec.Beam as Beam

main :: IO ()
main =
  LBS.writeFile "test_module.beam" $
    Beam.encode "test_module"
      [ Beam.export "tuple_of_one" 0
      [ label (Beam.Label 1)
      , func_info "tuple_of_one" 0
      , label (Beam.Label 2)
      , move (Beam.Tuple [Beam.Integer 1]) (Beam.X 0)
      , return'

After you run that program, you can load the resulting module from the Erlang shell!

$ erl
1> l(test_module).
2> test_module:tuple_of_one().

You can find an example project on GitHub.


Use Stack:

stack build --test


Thanks to the following projects, which helped me understand the BEAM file format: