Packages

zigler

0.1.2
0.16.0 0.15.2 0.14.1 0.14.0 0.13.3 0.13.2 0.13.1 retired 0.13.0 retired 0.12.1 0.11.1 0.11.1-pre-4 0.11.1-pre-3 0.11.1-pre-2 0.11.1-pre-1 0.11.0 0.10.3 0.10.2 0.10.1 0.9.1 0.8.1 0.7.3 0.7.2 0.7.1 0.3.2 0.3.1 0.3.0 0.3.0-pre3 0.3.0-pre2 0.3.0-pre 0.2.0 0.1.3 0.1.2 0.1.1 0.1.0

Zig nif library

HexDocs

Current section

Files

Jump to
Readme
34 Versions
4 Dependencies
Dependants
Files
Activity
zigler lib zigler nif.ex
Raw

lib/zigler/nif.ex 

defmodule Zigler.Nif do

  @moduledoc false



  # 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:

  #

  # - name: (`t:atom/0`) the function name to be bound into the module

  # - arity: (`t:non_neg_integer/0`) the arity of the erlang function (the zig

  #   function may have a different arity).

  # - doc: (`t:iodata/0`) zig docstrings which should be turned into elixir docs

  # - params: (`t:String.t/0`) a list of zig types which are the parameters for

  #   the function

  # - retval: (`t:String.t/0`) the type of the return value



  @enforce_keys [:name, :arity]

  defstruct @enforce_keys ++ [doc: nil, params: [], retval: nil]



  @type t :: %__MODULE__{

    name:   atom,

    arity:  non_neg_integer,

    doc:    iodata | nil,

    params: [String.t],

    retval: String.t

  }



end