Merge branch 'master' into feature/inline

Author: filmor

.clippy.toml

@@ -0,0 +1 @@
+msrv = "1.56.1"

.github/workflows/main.yml

@@ -10,66 +10,24 @@ on:
     - cron: '0 0 * * 3'
 
 jobs:
-  clippy:
-    name: Clippy
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions-rs/toolchain@v1
-        with:
-            toolchain: stable
-            components: clippy
-            override: true
-      - uses: actions-rs/clippy-check@v1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          args: --all-targets --all-features -- -D warnings
-
-  clippy-windows:
-    name: Clippy-Windows
-    runs-on: windows-latest
-    steps:
-      - uses: actions/checkout@v1
-      - name: Install Erlang/Elixir
-        run: choco install elixir
-      - name: Extend PATH
-        run: echo "C:\\ProgramData\\chocolatey\\lib\\Elixir\\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
-      - name: Build API
-        working-directory: rustler_sys
-        run: |
-            cargo build
-      - uses: actions-rs/toolchain@v1
-        with:
-            toolchain: stable
-            components: clippy
-            override: true
-      - uses: actions-rs/clippy-check@v1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          args: --all-targets --all-features -- -D warnings
-
   format:
     name: Format
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
-      - uses: actions-rs/toolchain@v1
+      - uses: actions/checkout@v3
+
+      - uses: dtolnay/rust-toolchain@stable
         with:
-            toolchain: stable
-            components: rustfmt
-            override: true
+          components: rustfmt
 
       - name: Install Erlang/Elixir
         uses: erlef/setup-beam@v1
         with:
-          otp-version: "25.0.0"
-          elixir-version: "1.13.4"
+          otp-version: "25"
+          elixir-version: "1.14"
 
       - name: Check cargo fmt
-        uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: --all -- --check
+        run: cargo fmt --all -- --check
 
       - name: Check mix format (rustler_mix)
         working-directory: rustler_mix
@@ -79,123 +37,97 @@ jobs:
         working-directory: rustler_tests
         run: mix format --check-formatted
 
-  rustler_mix_test:
-    runs-on: ubuntu-latest
+  build:
+    name: Build ${{matrix.os}} ${{matrix.toolchain}}
+    runs-on: ${{matrix.os}}-latest
+    strategy:
+      matrix:
+        os: [ubuntu, windows, macos]
+        toolchain: [stable, nightly]
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v3
 
-      - name: Install Rust stable toolchain
-        uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@stable
         with:
-          toolchain: stable
-          override: true
+          toolchain: ${{matrix.toolchain}}
 
-      - name: Install Erlang/Elixir
-        uses: erlef/setup-beam@v1
+      - uses: Swatinem/rust-cache@v2
         with:
-          otp-version: "24.1.7"
-          elixir-version: 1.13
+          cache-on-failure: true
+          shared-key: rustler
 
-      - name: Test rustler_mix
-        working-directory: rustler_mix
-        run: ./test.sh
+      - run: cargo build
 
-  test_windows:
-    name: Windows
-    runs-on: windows-latest
+  clippy:
+    name: Clippy ${{matrix.os}}
+    runs-on: ${{matrix.os}}-latest
+    needs: [build]
+    strategy:
+      matrix:
+        os: [ubuntu, windows, macos]
     steps:
-      - name: Checkout sources
-        uses: actions/checkout@v1
-
-      - name: Install Erlang/Elixir
-        run: choco install elixir
+      - uses: actions/checkout@v3
 
-      - name: Install Rust stable toolchain
-        uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@stable
         with:
-          toolchain: stable
-          override: true
+          components: clippy
 
-      - name: Extend PATH
-        run: echo "C:\\ProgramData\\chocolatey\\lib\\Elixir\\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
+      - uses: Swatinem/rust-cache@v2
+        with:
+          shared-key: rustler
+          save-if: false
 
-      - name: Hex
-        run: mix local.hex --force
-
-      - name: Test rustler_mix
-        working-directory: rustler_mix
-        run: |
-          mix deps.get
-          mix test
-
-      - name: Test rustler_tests
-        working-directory: rustler_tests
-        run: |
-          mix deps.get
-          mix test
+      - run: cargo clippy --all-targets --all-features -- -D warnings
 
   test:
-    name: OTP ${{matrix.pair.erlang}} / Elixir ${{matrix.pair.elixir}} / Rust ${{matrix.rust}}
-    runs-on: ubuntu-latest
+    name: OTP ${{matrix.pair.erlang}} / Elixir ${{matrix.pair.elixir}} / Rust ${{matrix.rust}} / OS ${{matrix.os}}
+    needs: [build]
     strategy:
       matrix:
         pair:
-          - { erlang: "25.0.0", elixir: "1.13.4" }
-          - { erlang: "24.3.4", elixir: "1.13.0" }
-          - { erlang: "24.3.4", elixir: "1.12.3" }
-          - { erlang: "24.3.4", elixir: "1.11.4" }
-          - { erlang: "23.3.4.14", elixir: "1.11.4" }
+          - { erlang: "26", elixir: "1.14", latest: true }
+          - { erlang: "25", elixir: "1.14" }
+          - { erlang: "24", elixir: "1.13" }
         rust:
           - stable
-          - beta
           - nightly
+        os:
+          - macos
+          - windows
+          - ubuntu
+        exclude:
+          # TODO Remove this once setup-beam is fixed to work around OTP26's
+          # regression
+          - os: windows
+            pair: { erlang: "26", elixir: "1.14", latest: true }
+    runs-on: ${{matrix.os}}-latest
+
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v1
+        uses: actions/checkout@v3
 
       - name: Install Erlang/Elixir
         uses: erlef/setup-beam@v1
         with:
           otp-version: ${{matrix.pair.erlang}}
           elixir-version: ${{matrix.pair.elixir}}
+        if: "!startsWith(matrix.os, 'macos')"
 
-      - name: Install Rust ${{matrix.rust}} toolchain
-        uses: actions-rs/toolchain@v1
-        with:
-          toolchain: ${{matrix.rust}}
-          override: true
-
-      - run: cargo test
-
-      - name: Test rustler_mix
-        working-directory: rustler_mix
-        run: |
-          mix deps.get
-          mix test
-
-      - name: Test rustler_tests
-        working-directory: rustler_tests
-        run: |
-          mix deps.get
-          mix test
-
-  test_macos:
-    name: macos-11 test
-    runs-on: macos-11
-    steps:
-      - name: Checkout sources
-        uses: actions/checkout@v1
-
-      - name: Install Erlang/Elixir
+      - name: Install Erlang/Elixir with Brew
         run: |
           brew install elixir
           mix local.hex --force
+        if: "startsWith(matrix.os, 'macos')"
 
       - name: Install Rust ${{matrix.rust}} toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{matrix.rust}}
+
+      - uses: Swatinem/rust-cache@v2
         with:
-          toolchain: stable
-          override: true
+          shared-key: rustler
+          save-if: false
 
       - run: cargo test
 
@@ -210,3 +142,8 @@ jobs:
         run: |
           mix deps.get
           mix test
+
+      - name: Test mix project with example created from template
+        working-directory: rustler_mix
+        run: ./test.sh
+        if: "startsWith(matrix.os, 'ubuntu') && matrix.pair.latest"

CHANGELOG.md

@@ -7,6 +7,98 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 See [`UPGRADE.md`](./UPGRADE.md) for additional help when upgrading to newer versions.
 
+## [unreleased]
+
+## Added
+
+* `ErlOption<T>` to provide an ergonomic option type for Erlang (#507, thanks @tatsuya6502)
+
+### Changed
+
+* Use Cargo features to define the NIF version level (#537), deprecating
+  `RUSTLER_NIF_VERSION`
+
+## [0.28.0] - 2023-04-24
+
+### Added
+
+* Support OTP 26 (#526, thanks @philss)
+* Support tuples in NIF macro (#520, #527, thanks @denumerate and @philss)
+* Supportfor `load_data_fun` to compute `load_data` at runtime (#413, thanks @kaaboaye)
+
+### Changed
+
+* Enhanced NIF macro error messages for invalid attributes (#525, thanks @philss)
+
+## [0.27.0] - 2023-01-17
+
+### BREAKING
+
+* `MIX_ENV` is no longer considered for determining the build profile. Now, the
+  profile defaults to `:release`. Use the `:mode` option to pick another
+  profile explicitly. (#496)
+
+### Added
+
+* `ResourceArc::make_binary` for safe use of `enif_make_resource_binary` (#487)
+* `OwnedBinary` is now `Sync` (#493)
+* Specified MSRV to be 1.56.1.
+
+### Fixed
+
+* Documentation for `load` (#501, thanks @ishitatsuyuki)
+
+### Changed
+
+* Edition 2021 for the rustler mix template (#512, thanks @ayrat555)
+
+## [0.26.0] - 2022-09-02
+
+### Highlight
+
+#### TaggedEnum
+
+We added `TaggedEnum`, which is a generalized enum type (#440, thanks to @SeokminHong!). Example:
+
+```rust
+#[derive(NifTaggedEnum)]
+pub enum TaggedEnum1 {
+    Named { x: i32, y: i32 },
+    String1(String),
+    String2(String),
+    Untagged,
+}
+```
+
+On the Elixir side, the variants are represented as two-tuples `{tag::atom(),
+inner::term()} | atom()`, where the `inner` term is
+
+* a map for the variant `Named` in the example above
+* a binary for the `String1` and `String2` variants
+
+The `Untagged` variant is represented as the atom `:untagged` in Elixir.
+
+### Added
+
+* Added `Clone` and `Copy` for `TermType` (#476, thanks @dvic)
+* Added `Env.whereis_pid()` (#456, thanks @Qqwy)
+
+### Improved
+
+* Use `&[impl Encoder]` for keys and values in `map_from_arrays()` to improve ergonomics (#453, thanks @SeokminHong)
+* Improved encode/decode performance of TaggedEnum considerably (#482, thanks @cleaton)
+* Test on OTP 25 (#455)
+
+### Fixed
+
+* Lifetime handling in `rustler_codegen` (#483, thanks @turion @SeokminHong and @neosimsim)
+* Support multiple variants with same field names in TaggedEnum (#482, thanks @cleaton)
+* Support .toml file extension for cargo config (#468, thanks @joshuataylor for the report in #467)
+* Disambiguate `encode`/`decode` in generated code (#466, thanks @SeokminHong)
+* Migrate CI to `erlef/setup-beam` (#457, thanks @SeokminHong)
+* Documentation of the `schedule` flag for `nif` macro (#444)
+* Improve documentation (#429, thanks @turion)
+
 ## [0.25.0] - 2022-04-11
 
 ### Added

Cargo.toml

@@ -8,4 +8,7 @@ members = [
   "rustler_tests/native/rustler_test",
   "rustler_tests/native/rustler_bigint_test",
   "rustler_tests/native/deprecated_macros",
+  "rustler_tests/native/dynamic_load",
+  "rustler_tests/native/rustler_compile_tests",
+  "rustler_benchmarks/native/benchmark",
 ]