aboutsummaryrefslogtreecommitdiff
path: root/native/treebitmap_nif/README.md
blob: 67e961cda67260c60f02a248a03cae5fac9869ae (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# NIF for Elixir.TreeBitmap.NIF

## To build the NIF module:

- Your NIF will now build along with your project.

## To load the NIF:

```elixir
defmodule TreeBitmap.NIF do
    use Rustler, otp_app: :tree_bitmap, crate: "treebitmap_nif"

    # 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/hansihe/NifIo) is a complete example of a NIF written in Rust.