Packages

rustler

0.3.1
0.38.0 0.37.3 0.37.1 0.37.0 retired 0.36.2 0.36.1 0.36.0 0.35.1 0.35.0 0.34.0 0.33.0 0.32.1 0.31.0 0.30.0 0.29.1 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.22.2 0.22.1 0.22.0 0.22.0-rc.2 0.22.0-rc.1 0.22.0-rc.0 0.21.1 0.21.0 0.20.0 0.19.1 0.19.0 0.18.0 0.17.1 0.17.0 0.16.0 0.10.1 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.2 0.3.1 0.3.0 0.2.0 0.1.1 0.1.0 0.0.8 0.0.7 0.0.6 0.0.5 0.0.4 0.0.3 0.0.2 0.0.1

Mix compiler and runtime helpers for Rustler.

HexDocs

Current section

Files

Jump to
Readme
59 Versions
0 Dependencies
Dependants
Files
Activity
rustler priv templates basic README.md
Raw

priv/templates/basic/README.md 

# Nif for <%= project_name %>



## To build the NIF module:



  * Make sure your projects `mix.exs` has the `:rustler` compiler listed in the `project` function: `compilers: [:rustler] ++ Mix.compilers`

  * Add your crate to the `project` function: `rustler_crates: ["/native/<%= library_name %>"]`

  * Your NIF will now build along with your project.



## To load the NIF:



```elixir

defmodule <%= module %> do

    require Rustler



    @on_load :load_nif

    def load_nif do

        Rustler.load_nif("<%= library_name %>")

    end



    # When your NIF is loaded, it will override this function.

    def add(_a, _b), do: throw :nif_not_loaded

end

```



## Examples

[This](https://github.com/hansihe/NifIo) is a complete example of a NIF written in Rust.