Packages

Mix compiler and runtime helpers for Rustler.

Current section

Files

Jump to
rustler priv templates basic README.md
Raw

priv/templates/basic/README.md

# NIF for <%= module %>
## To build the NIF module:
- Your NIF will now build along with your project.
## To load the NIF:
```elixir
defmodule <%= module %> do
use Rustler, otp_app: :<%= otp_app %>, crate: "<%= library_name %>"
# When your NIF is loaded, it will override this function.
def add(_a, _b), do: :erlang.nif_error(:nif_not_loaded)
end
```
## Examples
[This](https://github.com/rusterlium/NifIo) is a complete example of a NIF written in Rust.