mirror of
https://github.com/philomena-dev/philomena.git
synced 2024-11-24 04:27:59 +01:00
23 lines
845 B
Markdown
23 lines
845 B
Markdown
|
# NIF for Elixir.Furbooru.Markdown
|
||
|
|
|
||
|
|
## To build the NIF module:
|
||
|
|
|
||
|
|
- Make sure your projects `mix.exs` has the `:rustler` compiler listed in the `project` function: `compilers: [:rustler] ++ Mix.compilers()` If there already is a `:compilers` list, you should append `:rustler` to it.
|
||
|
|
- Add your crate to the `rustler_crates` attribute in the `project function. [See here](https://hexdocs.pm/rustler/basics.html#crate-configuration).
|
||
|
|
- Your NIF will now build along with your project.
|
||
|
|
|
||
|
|
## To load the NIF:
|
||
|
|
|
||
|
|
```elixir
|
||
|
|
defmodule Furbooru.Markdown do
|
||
|
|
use Rustler, otp_app: <otp-app>, crate: "furbooru_markdown"
|
||
|
|
|
||
|
|
# 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.
|