Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
See UPGRADE.md
for additional help when upgrading to newer versions.
[0.24.0] - 2021-02-24
Added
- A
NewBinary
type to create binaries in Rust without going throughOwnedBinary
. This can improve performance. Thanks @dlesl! TermType
derivesEq
andPartialEq
.
Updated
rustler_mix
: Bumped required toml dependency to 0.6- Bumped
rustler_sys
dependency to~2.2
.
Changed
- Rustler supports the latest 3 versions of Elixir and OTP. Currently, those are Elixir => 1.11 and OTP >= 22.
Fixed
- Set library file extension based on the compile target, thanks @cocoa-xu!
- Relaxed Jason version requirement to ~> 1.0
- Various typos in the documentation, thanks @kianmeng!
[0.23.0] - 2021-12-22
Added
NifException
for using Elixir exception structs- Hashing for term
- Hash and Equality for
Binary
andOwnedBinary
Changed
- Rustler changed its supported range of OTP and Elixir versions. We aim to support the three newest versions of OTP and Elixir.
- The decoder for
Range
requires that:step
equals1
. The:step
field was introduced with Elixir v1.12 and cannot be represented with Rust'sRangeInclusive
. - NIF API bindings are generated using Rust
Fixed
mix rustler.new
with Elixir v1.13- Template config for
macos
- Crash if metadata cannot be retrieved while compiling (#398)
[0.22.2] - 2021-10-07
Fixed
- Fixed a regression introduced with #386:
Rustler.Compiler.Config
called intocargo
whenskip_compilation?
was set, breaking setups where cargo is not installed. Fixed with #389, thanks @karolsluszniak
[0.22.1] - 2021-10-05
Fixed
- [Breaking change] codegen-generated decoders always raise an error instead of causing the calling NIF to return an atom in some cases
- Fix codegen problem for untagged enums (#370)
- Fix handling local dependencies with
@external_resources
(#381)
[0.22.0] - 2021-06-22
Added
- Simple
Debug
impl forrustler::Error
- Support newtype and tuple structs for
NifTuple
andNifRecord
rustler::Error::Term
encoding an arbitrary boxed encoder, returning{:error, term}
- Generic encoder/decoder for
HashMap<T, U>
, whereT: Decoder
andU: Decoder
Fixed
- Compilation time of generated decoders has been reduced significantly.
- Fixed a segfault caused by
OwnedEnv::send_and_clear
Changes
- Renamed
Pid
toLocalPid
to clarify that it can't point to a remote process - Dependencies have been updated.
- Derive macros have been refactored.
- Macros have been renamed and old ones have been deprecated:
rustler_export_nifs!
is nowrustler::init!
rustler_atoms!
is nowrustler::atoms!
resource_struct_init!
is nowrustler::resource!
- New
rustler::atoms!
macro removed theatom
prefix from the name:
//
// Before
//
rustler::rustler_atoms! {
atom ok;
atom error;
atom renamed_atom = "Renamed";
}
//
// After
//
rustler::atoms! {
ok,
error,
renamed_atom = "Renamed",
}
- NIF functions can be initialized with a simplified syntax:
//
// Before
//
rustler::rustler_export_nifs! {
"Elixir.Math",
[
("add", 2, add)
],
None
}
//
// After
//
rustler::init!("Elixir.Math", [add]);
- NIFs can be derived from regular functions, if the arguments implement
Decoder
and the return type implementsEncoder
:
//
// Before
//
fn add<'a>(env: Env<'a>, args: &[Term<'a>]) -> Result<Term<'a>, Error> {
let num1: i64 = args[0].decode()?;
let num2: i64 = args[1].decode()?;
Ok((atoms::ok(), num1 + num2).encode(env))
}
//
// After
//
#[rustler::nif]
fn add(a: i64, b: i64) -> i64 {
a + b
}
rustler::nif
exposes more options to configure a NIF were the NIF is defined:
#[rustler::nif(schedule = "DirtyCpu")]
pub fn dirty_cpu() -> Atom {
let duration = Duration::from_millis(100);
std::thread::sleep(duration);
atoms::ok()
}
#[rustler::nif(name = "my_add")]
fn add(a: i64, b: i64) -> i64 {
a + b
}
Deprecations
The rustler compiler has been deprecated and will be removed with v1.0. NIFs
are no longer defined in mix.exs
, but are configured with use Rustler
. See
the documentation for the Rustler
module. To migrate to the new
configuration:
Drop
:rustler
from the:compilers
key in yourmix.exs
project/0
functionDrop
:rustler_crates
fromproject/0
and move the configurations into theuse Rustler
of your NIF module or application config:# config/dev.exs config :my_app, MyApp.Native, mode: :debug
For more information, see the documentation.
[0.21.0] - 2019-09-07
Added
- Support for OTP22.
- Rust linting with clippy.
- Support for decoding IOLists as binaries,
Term::decode_as_binary
.
Changes
rustler_codegen
is now reexported by therustler
crate. Depending on therustler_codegen
crate is deprecated.erlang_nif-sys
has been renamed torustler_sys
and vendored into the rustler repo.- Replaced the hand-rolled TOML parser in
rustler_mix
with thetoml-elixir
package. - Improve error messages for derived encoders/decoders.
- Rust
bool
now corresponds only to booleans (false
,true
) in Elixir. Previously,nil
andfalse
were both decodable tobool
. To use the previous behaviour, aTruthy
newtype was introduced.