Rust/README.md

Nix Flakes Rust Helper

A helper flake for automatically generating flake contents for rust projects, including building, testing, documenting, auditing, and linting of rust projects, as well as other useful toolchain packages

Provided toolchain

DevShell

The provided devShell includes the following rust specific packages, in addition to the usual rust toolchain (including rust-analyzer):

• cargo-llvm-cov
• cargo-nextest
• cargo-udeps
• cargo-audit
• cargo-release
• cargo-deny

These general workflow utilities are provided:

• gnuplot
• pre-commit
• git-lfs
• git-cliff
• nixfmt
• mdformat

Dependencies

The following dependencies are provided by default:

• cmake
• openssl
• pkg-config

Usage

Repository with a single crate (not a workspace)

Create a flake.nix in the root of the repository with the following contents:

{
  inputs = { rust = { url = "./.."; }; };
  description = "Simple Test Package";

  outputs = { self, nixpkgs, rust }:
    rust.single {
      crateName = "CRATE_NAME";
      src = ./.;
    };
}

Optionally create a .envrc in the root of the repository with the following contents:

use flake