# Rustler Bindings

> Rustler conventions for building Elixir NIFs from a Rust core: nif macros, tagged {:ok,_}/{:error,_} tuples, dirty schedulers, ResourceArc state, NifStruct derives, and mix compile. Load when generating or reviewing Rustler Elixir NIF bindings for a Rust library.

- Skill: `goldziher/rustler-bindings` (Agent Skill)
- Install (CLI): `npx skillmds@latest add goldziher/rustler-bindings`
- Raw SKILL.md: https://api.skillmd.com/api/skills/goldziher/rustler-bindings/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: goldziher (https://skillmd.com/u/goldziher)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/goldziher/rustler-bindings

---


- Use `#[rustler::nif]` for Elixir NIF functions. Use `#[module = "Elixir.ModuleName"]` for module naming.
- Return tagged tuples: `{:ok, value}` / `{:error, reason}`. Use Rustler encoders/decoders for type mapping.
- Use `rustler::Error` for NIF error handling. Map Rust errors to descriptive Elixir error tuples.
- Keep NIF functions fast (<1ms) to avoid scheduler issues. Use `#[rustler::nif(schedule = "DirtyCpu")]` for long operations.
- Build with `mix compile` (Rustler compiler). Test from Elixir using ExUnit.
- Use `ResourceArc<T>` for sharing Rust state across NIF calls. Implement `Drop` for cleanup.
- Use `#[derive(NifStruct)]` and `#[derive(NifUnitEnum)]` for Elixir-compatible types.
- Keep Elixir NIF wrapper thin — business logic in Rust, Elixir provides functional API.
- Handle binary data with `Binary` and `OwnedBinary` types.
- Anti-patterns: no panics in NIFs (crashes the BEAM VM), no blocking the scheduler, no I/O in NIFs.

