#nif #erlang #elixir #bindings

erl_nif

Write Erlang and Elixir NIFs in Rust

4 releases (2 breaking)

0.3.1 Jun 24, 2021
0.3.0 Jun 23, 2021
0.2.0 Jun 23, 2021
0.1.0 Jun 16, 2021

MIT license

85KB
2.5K SLoC

erl_nif

This crate provides bindings to the erl_nif C API, making it easy to write native extensions for Erlang and Elixir in Rust.

Example

Write your NIF in Rust:

erl_nif::init!(
  name: "Elixir.Add",
  funcs: [add],
);

#[erl_nif::nif]
fn add(a: u64, b: u64) -> Result<u64, String> {
  Ok(a + b)
}

Then load it in Elixir.

defmodule Add do
  @on_load {:init, 0}
  def init do
    path = :filename.join(:code.priv_dir(:add), "libadd")
    :ok = :erlang.load_nif(path, nil)
  end

  def add(_) do
    :erlang.nif_error(:nif_not_loaded)
  end
end

See the examples folder for a complete example.

Serde integration

To make it easy to move data structures between Rust and Elixir, the erl_nif crate supports integration with serde.

#[derive(serde::Serialize, serde::Deserialize)]
#[serde(rename = "Elixir.Example.Contact")]
struct Contact {
  name: String,
  email: String,
}
defmodule Example do
  defmodule Contact do
    defstruct [
      :name,
      :email
    ]
  end
end

Dependencies

~1–1.5MB
~34K SLoC

`