Expand description
Low level Rust bindings to the Erlang NIF API.
Macros§
Structs§
- DynNif
Callbacks - ErlNif
Binary - See ErlNifBinary in the Erlang docs.
- ErlNif
Env - See ErlNifEnv in the Erlang docs.
- ErlNif
Func - See ErlNifFunc in the Erlang docs.
- ErlNif
MapIterator - See ErlNifMapIterator in the Erlang docs.
- ErlNif
Monitor - See ErlNifMonitor in the Erlang docs.
- ErlNif
Pid - See ErlNifPid in the Erlang docs.
- ErlNif
Port - See ErlNifPort in the Erlang docs.
- ErlNif
Resource Type - See ErlNifResourceType in the Erlang docs.
- ErlNif
Resource Type Init - See ErlNifResourceTypeInit in the Erlang docs.
- ErlNif
SysInfo - See ErlNifSysInfo in the Erlang docs.
Enums§
- ErlNif
Char Encoding - See ErlNifCharEncoding in the Erlang docs.
- ErlNif
Hash - See ErlNifHash in the Erlang docs.
- ErlNif
MapIterator Entry - See ErlNifMapIteratorEntry in the Erlang docs.
- ErlNif
Option - See ErlNifOption in the Erlang docs.
- ErlNif
Resource Flags - See ErlNifResourceFlags in the Erlang docs.
- ErlNif
Term Type - See ErlNifTermType in the Erlang docs.
- ErlNif
Time Unit - See ErlNifTimeUnit in the Erlang docs.
- c_void
- Equivalent to C’s
void
type when used as a pointer.
Constants§
- ERL_
NIF_ BIN2TERM_ SAFE - ERL_
NIF_ DIRTY_ JOB_ CPU_ BOUND - ERL_
NIF_ DIRTY_ JOB_ IO_ BOUND - ERL_
NIF_ DIRTY_ NIF_ OPTION - ERL_
NIF_ ENTRY_ OPTIONS - ERL_
NIF_ SELECT_ ERROR_ CANCELLED - ERL_
NIF_ SELECT_ FAILED - ERL_
NIF_ SELECT_ NOTSUP - ERL_
NIF_ SELECT_ READ - ERL_
NIF_ SELECT_ READ_ CANCELLED - ERL_
NIF_ SELECT_ STOP - ERL_
NIF_ SELECT_ WRITE - ERL_
NIF_ SELECT_ WRITE_ CANCELLED - ERL_
NIF_ THR_ DIRTY_ CPU_ SCHEDULER - ERL_
NIF_ THR_ DIRTY_ IO_ SCHEDULER - ERL_
NIF_ THR_ NORMAL_ SCHEDULER - ERL_
NIF_ THR_ UNDEFINED - ERL_
NIF_ TIME_ ERROR - Error return value for
enif_monotonic_time()
,enif_time_offset()
, andenif_convert_time_unit()
. - ERL_
NIF_ UNIQUE_ MONOTONIC - ERL_
NIF_ UNIQUE_ POSITIVE - NIF_
MAJOR_ VERSION - NIF_
MINOR_ VERSION
Functions§
- enif_
alloc ⚠ - See enif_alloc in the Erlang docs.
- enif_
alloc_ ⚠binary - See enif_alloc_binary in the Erlang docs.
- enif_
alloc_ ⚠env - See enif_alloc_env in the Erlang docs.
- enif_
alloc_ ⚠resource - See enif_alloc_resource in the Erlang docs.
- enif_
binary_ ⚠to_ term - See enif_binary_to_term in the Erlang docs.
- enif_
clear_ ⚠env - See enif_clear_env in the Erlang docs.
- enif_
compare ⚠ - See enif_compare in the Erlang docs.
- enif_
compare_ ⚠monitors - See enif_compare_monitors in the Erlang docs.
- enif_
compare_ ⚠pids - See enif_compare_pids in the Erlang docs
- enif_
consume_ ⚠timeslice - See enif_consume_timeslice in the Erlang docs.
- enif_
convert_ ⚠time_ unit - See enif_convert_time_unit in the Erlang docs.
- enif_
cpu_ ⚠time - See enif_cpu_time in the Erlang docs.
- enif_
demonitor_ ⚠process - See enif_demonitor_process in the Erlang docs.
- enif_
dlopen ⚠ - See enif_dlopen in the Erlang docs.
- enif_
dlsym ⚠ - See enif_dlsym in the Erlang docs.
- enif_
dynamic_ ⚠resource_ call - See enif_dynamic_resource_call in the Erlang docs.
- enif_
free ⚠ - See enif_free in the Erlang docs.
- enif_
free_ ⚠env - See enif_free_env in the Erlang docs.
- enif_
get_ ⚠atom - See enif_get_atom in the Erlang docs.
- enif_
get_ ⚠atom_ length - See enif_get_atom_length in the Erlang docs.
- enif_
get_ ⚠double - See enif_get_double in the Erlang docs.
- enif_
get_ ⚠int - See enif_get_int in the Erlang docs.
- enif_
get_ ⚠int64 - See enif_get_int64 in the Erlang docs.
- enif_
get_ ⚠list_ cell - See enif_get_list_cell in the Erlang docs.
- enif_
get_ ⚠list_ length - See enif_get_list_length in the Erlang docs.
- enif_
get_ ⚠local_ pid - See enif_get_local_pid in the Erlang docs.
- enif_
get_ ⚠local_ port - See enif_get_local_port in the Erlang docs.
- enif_
get_ ⚠long - See enif_get_long in the Erlang docs.
- enif_
get_ ⚠map_ size - See enif_get_map_size in the Erlang docs.
- enif_
get_ ⚠map_ value - See enif_get_map_value in the Erlang docs.
- enif_
get_ ⚠resource - See enif_get_resource in the Erlang docs.
- enif_
get_ ⚠string - See enif_get_string in the Erlang docs.
- enif_
get_ ⚠string_ length - See enif_get_string_length in the Erlang docs.
- enif_
get_ ⚠tuple - See enif_get_tuple in the Erlang docs.
- enif_
get_ ⚠uint - See enif_get_uint in the Erlang docs.
- enif_
get_ ⚠uint64 - See enif_get_uint64 in the Erlang docs.
- enif_
get_ ⚠ulong - See enif_get_ulong in the Erlang docs.
- enif_
getenv ⚠ - See enif_getenv in the Erlang docs.
- enif_
has_ ⚠pending_ exception - See enif_has_pending_exception in the Erlang docs.
- enif_
hash ⚠ - See enif_hash in the Erlang docs.
- enif_
init_ ⚠resource_ type - See enif_init_resource_type in the Erlang docs.
- enif_
inspect_ ⚠binary - See enif_inspect_binary in the Erlang docs.
- enif_
inspect_ ⚠iolist_ as_ binary - See enif_inspect_iolist_as_binary in the Erlang docs.
- enif_
is_ ⚠atom - See enif_is_atom in the Erlang docs.
- enif_
is_ ⚠binary - See enif_is_binary in the Erlang docs.
- enif_
is_ ⚠current_ process_ alive - See enif_is_current_process_alive in the Erlang docs.
- enif_
is_ ⚠empty_ list - See enif_is_empty_list in the Erlang docs.
- enif_
is_ ⚠exception - See enif_is_exception in the Erlang docs.
- enif_
is_ ⚠fun - See enif_is_fun in the Erlang docs.
- enif_
is_ ⚠identical - See enif_is_identical in the Erlang docs.
- enif_
is_ ⚠list - See enif_is_list in the Erlang docs.
- enif_
is_ ⚠map - See enif_is_map in the Erlang docs.
- enif_
is_ ⚠number - See enif_is_number in the Erlang docs.
- enif_
is_ ⚠pid - See enif_is_pid in the Erlang docs.
- enif_
is_ ⚠pid_ undefined - See enif_is_pid_undefined in the Erlang docs.
- enif_
is_ ⚠port - See enif_is_port in the Erlang docs.
- enif_
is_ ⚠port_ alive - See enif_is_port_alive in the Erlang docs.
- enif_
is_ ⚠process_ alive - See enif_is_process_alive in the Erlang docs.
- enif_
is_ ⚠ref - See enif_is_ref in the Erlang docs.
- enif_
is_ ⚠tuple - See enif_is_tuple in the Erlang docs.
- enif_
keep_ ⚠resource - See enif_keep_resource in the Erlang docs.
- enif_
make_ ⚠atom - See enif_make_atom in the Erlang docs.
- enif_
make_ ⚠atom_ len - See enif_make_atom_len in the Erlang docs.
- enif_
make_ ⚠badarg - See enif_make_badarg in the Erlang docs.
- enif_
make_ ⚠binary - See enif_make_binary in the Erlang docs.
- enif_
make_ ⚠copy - See enif_make_copy in the Erlang docs.
- enif_
make_ ⚠double - See enif_make_double in the Erlang docs.
- enif_
make_ ⚠existing_ atom - See enif_make_existing_atom in the Erlang docs.
- enif_
make_ ⚠existing_ atom_ len - See enif_make_existing_atom_len in the Erlang docs.
- enif_
make_ ⚠int - See enif_make_int in the Erlang docs.
- enif_
make_ ⚠int64 - See enif_make_int64 in the Erlang docs.
- enif_
make_ ⚠list_ cell - See enif_make_list_cell in the Erlang docs.
- enif_
make_ ⚠list_ from_ array - See enif_make_list_from_array in the Erlang docs.
- enif_
make_ ⚠long - See enif_make_long in the Erlang docs.
- enif_
make_ ⚠map_ from_ arrays - See enif_make_map_from_arrays in the Erlang docs.
- enif_
make_ ⚠map_ put - See enif_make_map_put in the Erlang docs.
- enif_
make_ ⚠map_ remove - See enif_make_map_remove in the Erlang docs.
- enif_
make_ ⚠map_ update - See enif_make_map_update in the Erlang docs.
- enif_
make_ ⚠monitor_ term - See enif_make_monitor_term in the Erlang docs.
- enif_
make_ ⚠new_ atom - See enif_make_new_atom in the Erlang docs.
- enif_
make_ ⚠new_ atom_ len - See enif_make_new_atom_len in the Erlang docs.
- enif_
make_ ⚠new_ binary - See enif_make_new_binary in the Erlang docs.
- enif_
make_ ⚠new_ map - See enif_make_new_map in the Erlang docs.
- enif_
make_ ⚠pid - See enif_make_pid in the Erlang docs
- enif_
make_ ⚠ref - See enif_make_ref in the Erlang docs.
- enif_
make_ ⚠resource - See enif_make_resource in the Erlang docs.
- enif_
make_ ⚠resource_ binary - See enif_make_resource_binary in the Erlang docs.
- enif_
make_ ⚠reverse_ list - See enif_make_reverse_list in the Erlang docs.
- enif_
make_ ⚠string - See enif_make_string in the Erlang docs.
- enif_
make_ ⚠string_ len - See enif_make_string_len in the Erlang docs.
- enif_
make_ ⚠sub_ binary - See enif_make_sub_binary in the Erlang docs.
- enif_
make_ ⚠tuple_ from_ array - See enif_make_tuple_from_array in the Erlang docs.
- enif_
make_ ⚠uint - See enif_make_uint in the Erlang docs.
- enif_
make_ ⚠uint64 - See enif_make_uint64 in the Erlang docs.
- enif_
make_ ⚠ulong - See enif_make_ulong in the Erlang docs.
- enif_
make_ ⚠unique_ integer - See enif_make_unique_integer in the Erlang docs.
- enif_
map_ ⚠iterator_ create - See enif_map_iterator_create in the Erlang docs.
- enif_
map_ ⚠iterator_ destroy - See enif_map_iterator_destroy in the Erlang docs.
- enif_
map_ ⚠iterator_ get_ pair - See enif_map_iterator_get_pair in the Erlang docs.
- enif_
map_ ⚠iterator_ is_ head - See enif_map_iterator_is_head in the Erlang docs.
- enif_
map_ ⚠iterator_ is_ tail - See enif_map_iterator_is_tail in the Erlang docs.
- enif_
map_ ⚠iterator_ next - See enif_map_iterator_next in the Erlang docs.
- enif_
map_ ⚠iterator_ prev - See enif_map_iterator_prev in the Erlang docs.
- enif_
monitor_ ⚠process - See enif_monitor_process in the Erlang docs.
- enif_
monotonic_ ⚠time - See enif_monotonic_time in the Erlang docs.
- enif_
now_ ⚠time - See enif_now_time in the Erlang docs.
- enif_
open_ ⚠resource_ type - See enif_open_resource_type in the Erlang docs.
- enif_
open_ ⚠resource_ type_ x - See enif_open_resource_type_x in the Erlang docs.
- enif_
port_ ⚠command - See enif_port_command in the Erlang docs.
- enif_
priv_ ⚠data - See enif_priv_data in the Erlang docs.
- enif_
raise_ ⚠exception - See enif_raise_exception in the Erlang docs.
- enif_
realloc ⚠ - See enif_realloc in the Erlang docs.
- enif_
realloc_ ⚠binary - See enif_realloc_binary in the Erlang docs.
- enif_
release_ ⚠binary - See enif_release_binary in the Erlang docs.
- enif_
release_ ⚠resource - See enif_release_resource in the Erlang docs.
- enif_
schedule_ ⚠nif - See enif_schedule_nif in the Erlang docs.
- enif_
select ⚠ - See enif_select in the Erlang docs.
- enif_
self ⚠ - See enif_self in the Erlang docs.
- enif_
send ⚠ - See enif_send in the Erlang docs.
- enif_
set_ ⚠option - See enif_set_option in the Erlang docs.
- enif_
set_ ⚠pid_ undefined - See enif_set_pid_undefined in the Erlang docs.
- enif_
sizeof_ ⚠resource - See enif_sizeof_resource in the Erlang docs.
- enif_
system_ ⚠info - See enif_system_info in the Erlang docs.
- enif_
term_ ⚠to_ binary - See enif_term_to_binary in the Erlang docs.
- enif_
term_ ⚠type - See enif_term_type in the Erlang docs.
- enif_
thread_ ⚠type - See enif_thread_type in the Erlang docs.
- enif_
time_ ⚠offset - See enif_time_offset in the Erlang docs.
- enif_
whereis_ ⚠pid - See enif_whereis_pid in the Erlang docs.
- enif_
whereis_ ⚠port - See enif_whereis_port in the Erlang docs.
- get_
enif_ ⚠fprintf - get_
enif_ ⚠make_ list - get_
enif_ ⚠make_ tuple - get_
enif_ ⚠snprintf - internal_
set_ ⚠symbols - internal_
write_ ⚠symbols
Type Aliases§
- ERL_
NIF_ TERM - ERL_
NIF_ UINT - ErlNif
Binary ToTerm - See ErlNifBinaryToTerm in the Erlang docs.
- ErlNif
Dirty Task Flags - ErlNif
Event - ErlNif
Resource Down - See ErlNifResourceDown in the Erlang docs.
- ErlNif
Resource Dtor - See ErlNifResourceDtor in the Erlang docs.
- ErlNif
Resource DynCall - See ErlNifResourceDynCall in the Erlang Docs.
- ErlNif
Resource Stop - See ErlNifResourceStop in the Erlang docs.
- ErlNif
Select Flags - See ErlNifSelectFlags in the Erlang docs.
- ErlNif
Time - See ErlNifTime in the Erlang docs.
- ErlNif
Unique Integer - See ErlNifUniqueInteger in the Erlang docs.
- c_char
- Equivalent to C’s
char
type. - c_
double - Equivalent to C’s
double
type. - c_int
- Equivalent to C’s
signed int
(int
) type. - c_long
- Equivalent to C’s
signed long
(long
) type. - c_uchar
- Equivalent to C’s
unsigned char
type. - c_uint
- Equivalent to C’s
unsigned int
type. - c_ulong
- Equivalent to C’s
unsigned long
type. - size_t