Rustler Mix v0.22.0-rc.0 Rustler View Source
Provides compile-time configuration for a NIF module.
When used, Rustler expects the :otp_app
as option.
The :otp_app
should point to the OTP application that
the dynamic library can be loaded from. For example:
defmodule MyNIF do
use Rustler, otp_app: :my_nif
end
This allows the module to be configured like so:
config :my_nif, MyNIF,
crate: :my_nif,
load_data: [1, 2, 3]
Configuration options:
:crate
- the name of the Rust crate (as an atom), if different from yourotp_app
value. If you have more than one crate in your project, you will need to be explicit about which crate you intend to use.:load_data
- Any valid term. This value is passed into the NIF when it is loaded (default:0
)
Either of the above options can be passed directly into the use
macro like so:
defmodule MyNIF do
use Rustler, otp_app: :my_nif, crate: :some_other_crate, load_data: :something
end
Link to this section Summary
Link to this section Functions
Link to this function
compile_config(mod, opts) View Source
Retrieves the compile time configuration.
Link to this function
nif_versions() View Source
Supported NIF API versions.