rhai_rustler v0.1.3

Rhai rustler

CI Rust CI NIFs precompilation Hex.pm Hex Docs

Elixir NIF bindings for Rhai, an embedded scripting language and engine for Rust

Please refer to The Rhai Book for extended information about the language.

installation

 Installation

Add :rhai_rustler to the list of dependencies in mix.exs:

def deps do
  [
    {:rhai_rustler, "~> 0.1.0"}
  ]
end

usage

 Usage 

iex> Rhai.eval("1 + 1")
{:ok, 2}

iex> Rhai.eval("a * b", %{"a" => 10, "b" => 10})
{:ok, 100}

iex> Rhai.eval("a == b", %{"a" => "tonio", "b" => "wanda"})
{:ok, false}

iex> Rhai.eval("a != b", %{"a" => "tonio", "b" => "wanda"})
{:ok, true}

iex> Rhai.eval("a.len()", %{"a" => [1, 2, 3]})
{:ok, 3}

iex> Rhai.eval("a.filter(|v| v > 3)", %{"a" => [1, 2, 3, 5, 8, 13]})
{:ok, [5, 8, 13]}

iex> Rhai.eval("a.b", %{"a" => %{"b" => 1}})
{:ok, 1}

iex> Rhai.eval("a + b", %{"a" => 10})
{:error, {:variable_not_found, "Variable not found: b (line 1, position 5)"}}

type-conversion-table

 Type conversion table

Elixir Types are converted to Rhai types (and back) as follows:

ElixirRhai
integer()Integer
float()Float
float()Decimal
bool()Boolean
String.t()String
String.t()Char
list()Array
tuple()Array
%{ String.t() => rhai_any() }Object map
nil()Empty
pid()Empty (not supported)
ref()Empty (not supported)
fun()Empty (not supported)
map()Empty (not supported)

rustler-precompiled

 Rustler precompiled

By default, you don't need the Rust toolchain installed because the lib will try to download a precompiled NIF file. In case you want to force compilation set the RHAI_RUSTLER_FORCE_BUILD environment variable to true or 1.

Precompiled NIFs are available for the following platforms:

  • aarch64-apple-darwin
  • x86_64-apple-darwin
  • x86_64-unknown-linux-gnu
  • x86_64-unknown-linux-musl
  • arm-unknown-linux-gnueabihf
  • aarch64-unknown-linux-gnu
  • aarch64-unknown-linux-musl
  • x86_64-pc-windows-msvc
  • x86_64-pc-windows-gnu

release-flow

 Release flow

Please follow this guide when releasing a new version of the library.

license

 License

This library is licensed under Apache 2.0 License. See LICENSE for details.

  • rhai The Rust crate doing most of the dirty work.
  • RustlerPrecompiled Use precompiled NIFs from trusted sources in your Elixir code.
  • NimbleLZ4 Major inspiration for the RustlerPrecompiled GitHub actions workflow and general setup.