summaryrefslogtreecommitdiffstats
path: root/doc/languages-frameworks
diff options
context:
space:
mode:
authorfigsoda <figsoda@pm.me>2022-11-28 17:25:46 -0500
committerfigsoda <figsoda@pm.me>2022-11-28 18:30:30 -0500
commit0f386d18962d699c2a9d29f5b62fa645ad887d5f (patch)
treefe9d58e1e0443ce8a0df22027b2212a3b47175f0 /doc/languages-frameworks
parent52153336fef629cf60422c9265e757f5ade160b6 (diff)
docs/rust: document `cargoNextestHook` and `useNextest`
Diffstat (limited to 'doc/languages-frameworks')
-rw-r--r--doc/languages-frameworks/rust.section.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/languages-frameworks/rust.section.md b/doc/languages-frameworks/rust.section.md
index db5d8c699e3a..591014480299 100644
--- a/doc/languages-frameworks/rust.section.md
+++ b/doc/languages-frameworks/rust.section.md
@@ -331,6 +331,20 @@ rustPlatform.buildRustPackage {
}
```
+#### Using `cargo-nextest` {#using-cargo-nextest}
+
+Tests can be run with [cargo-nextest](https://github.com/nextest-rs/nextest)
+by setting `useNextest = true`. The same options still apply, but nextest
+accepts a different set of arguments and the settings might need to be
+adapted to be compatible with cargo-nextest.
+
+```nix
+rustPlatform.buildRustPackage {
+ /* ... */
+ useNextest = true;
+}
+```
+
#### Setting `test-threads` {#setting-test-threads}
`buildRustPackage` will use parallel test threads by default,
@@ -474,6 +488,9 @@ you of the correct hash.
flags can be passed to the tests using `checkFlags` and
`checkFlagsArray`. By default, tests are run in parallel. This can
be disabled by setting `dontUseCargoParallelTests`.
+* `cargoNextestHook`: run tests using
+ [cargo-nextest](https://github.com/nextest-rs/nextest). The same
+ options for `cargoCheckHook` also applies to `cargoNextestHook`.
* `cargoInstallHook`: install binaries and static/shared libraries
that were built using `cargoBuildHook`.
* `bindgenHook`: for crates which use `bindgen` as a build dependency, lets