View Source Zig.Nif.Concurrency behaviour (zigler v0.11.0)

behaviour module which describes the interface for "plugins" which generate concurrency-specific code.

Summary

Types

concurrency()
table_entry()

Callbacks

render_elixir(t)
render_erlang(t)
render_zig(t)
resources(t)
table_entries(t)

returns "table_entry" tuples which are then used to generate the nif table. if a nif function needs multiple parts, for example, for concurrency management, then multiple entries should be returned.

Types

Link to this type

concurrency()

View Source 
@type concurrency() :: :synchronous | :dirty_cpu | :dirty_io
Link to this type

table_entry()

View Source 
@type table_entry() ::
  {name :: atom(), arity :: non_neg_integer(), function_pointer :: atom(),
   bootstrap :: concurrency()}

Callbacks

Link to this callback

render_elixir(t)

View Source 
@callback render_elixir(Zig.Nif.t()) :: Macro.t()
Link to this callback

render_erlang(t)

View Source 
@callback render_erlang(Zig.Nif.t()) :: term()
Link to this callback

render_zig(t)

View Source 
@callback render_zig(Zig.Nif.t()) :: iodata()
Link to this callback

resources(t)

View Source 
@callback resources(Zig.Nif.t()) :: [{:root, atom()}]
Link to this callback

table_entries(t)

View Source 
@callback table_entries(Zig.Nif.t()) :: [table_entry()]

returns "table_entry" tuples which are then used to generate the nif table. if a nif function needs multiple parts, for example, for concurrency management, then multiple entries should be returned.