zigler v0.3.0-pre3 API Reference

Modules

Inline NIF support for Zig

Phase One of Zigler compilation process.

all code responsible for generating zig code lives in this module.

Generates code for long-running nifs.

Translates the docstrings from your Zig code into Elixir documentation.

this struct represents all information a zigler module bound to a nif should have. WIP.

This datastructure represents structured information about a single nif inside of a Zigler.sigil_Z/2 block. This is used to generate the exported_nifs variable which is an array of ErlNifFunc structs. The following keys are implemented

resource parser object

resource cleanup struct

parses zig code and converts test blocks to test functions

occasionally zig and/or the llvm bits that get pulled down have errors. This module actively patches code when this situation occurs.

Hooks your zig code into ExUnit, by converting zig tests into ExUnit tests.

Mix Tasks

Used to generate documentation from your zig code and incorporate it into your Elixir documentation.