Fenix provides the minimal
, default
, and complete
profile of rust toolchains, latest
profile of nightly toolchains, nightly version of rust analyzer and its vscode extension.
It aims to be a replacement for rustup and the rust overlay provided by nixpkgs-mozilla.
Binary cache is available for x86_64-darwin
and x86_64-linux
on cachix
cachix use nix-community
Note: The nixpkgs from your system will be used when fenix is being used as an overlay, which may not be cached if you are using a stable/older version of nixpkgs. To fix this, use the packages directly or use the following workaround (see #79)
{
nixpkgs.overlays = [
(_: super: let pkgs = fenix.inputs.nixpkgs.legacyPackages.${super.system}; in fenix.overlays.default pkgs pkgs)
];
}
As a flake (recommended)
{
inputs = {
fenix = {
url = "github:nix-community/fenix";
inputs.nixpkgs.follows = "nixpkgs";
};
nixpkgs.url = "nixpkgs/nixos-unstable";
};
outputs = { self, fenix, nixpkgs }: {
packages.x86_64-linux.default = fenix.packages.x86_64-linux.minimal.toolchain;
nixosConfigurations.nixos = nixpkgs.lib.nixosSystem {
system = "x86_64-linux";
modules = [
({ pkgs, ... }: {
nixpkgs.overlays = [ fenix.overlays.default ];
environment.systemPackages = with pkgs; [
(fenix.complete.withComponents [
"cargo"
"clippy"
"rust-src"
"rustc"
"rustfmt"
])
rust-analyzer-nightly
];
})
];
};
};
}
As a set of packages
let
fenix = import (fetchTarball "https://github.com/nix-community/fenix/archive/main.tar.gz") { };
in
fenix.minimal.toolchain
As an overlay
# configuration.nix
{ pkgs, ... }: {
nixpkgs.overlays = [
(import "${fetchTarball "https://github.com/nix-community/fenix/archive/main.tar.gz"}/overlay.nix")
];
environment.systemPackages = with pkgs; [
(fenix.complete.withComponents [
"cargo"
"clippy"
"rust-src"
"rustc"
"rustfmt"
])
rust-analyzer-nightly
];
}
Following is a list of outputs, examples are prefixed with:
with fenix.packages.<system>;
(flakes), orwith import (fetchTarball "https://github.com/nix-community/fenix/archive/main.tar.gz") { };
Some outputs are toolchains, a rust toolchain in fenix is structured like this:
{
# components
cargo = <derivation>;
rustc = <derivation>; # rustc with rust-std
rustc-unwrapped = <derivation>; # rustc without rust-std, same as rustc.unwrapped
rustfmt = <derivation>; # alias to rustfmt-preview
rust-src = <derivation>; # RUST_SRC_PATH = "${fenix.complete.rust-src}/lib/rustlib/src/rust/library"
# ...
# derivation with all the components
toolchain = <derivation>;
# not available in nightly toolchains
# derivation with all the components from a profile
minimalToolchain = <derivation>;
defaultToolchain = <derivation>;
completeToolchain = <derivation>;
# withComponents : [string] -> derivation
# creates a derivation with the given list of components from the toolchain
withComponents = <function>;
}
combine : [derivation] -> derivation
Combines a list of components into a derivation. If the components are from the same toolchain, use withComponents
instead.
combine [
minimal.rustc
minimal.cargo
targets.wasm32-unknown-unknown.latest.rust-std
]
fromManifest : attrs ->
toolchain
Creates a toolchain from a rustup manifest
fromManifest (lib.importTOML ./channel-rust-nightly.toml)
fromManifestFile : path -> toolchain
Creates a toolchain from a rustup manifest file
fromManifestFile ./channel-rust-nightly.toml
toolchainOf : attrs -> toolchain
Creates toolchain from given arguments:
argument | default | description |
---|---|---|
root | "https://static.rust-lang.org/dist" |
root url from downloading manifest, usually left as default |
channel | "nightly" |
rust channel, one of "stable" , "beta" , "nightly" , and version number |
date | null |
date of the toolchain, latest if unset |
sha256 | null |
sha256 of the manifest, required in pure evaluation mode, set to lib.fakeSha256 to get the actual sha256 from the error message |
toolchainOf {
channel = "beta";
date = "2021-08-29";
sha256 = "0dkmjil9avba6l0l9apmgwa8d0h4f8jzgxkq3gvn8d2xc68ks5a5";
}
fromToolchainFile : attrs -> derivation
Creates a toolchain from a rust toolchain file, accepts the following arguments:
argument | description |
---|---|
file | path to the rust toolchain file, usually either ./rust-toolchain or ./rust-toolchain.toml , conflicts with dir |
dir | path to the directory that has rust-toolchain or rust-toolchain.toml , conflicts with file |
sha256 | sha256 of the manifest, required in pure evaluation mode, set to lib.fakeSha256 to get the actual sha256 from the error message |
fromToolchainFile {
file = ./rust-toolchain.toml;
sha256 = lib.fakeSha256;
}
fromToolchainFile { dir = ./.; }
default : toolchain
The default profile of the nightly toolchain, sometimes lags behind the minimal
profile
complete : toolchain
The complete profile of the nightly toolchain, usually lags behind the minimal
and default
profile
latest :
toolchain
A custom toolchain that contains all the components from the complete
profile but not from necessarily the same date.
Unlike the complete
profile, you get the latest version of the components, but risks a larger chance of incompatibility.
targets.${target}.* : toolchain
Toolchains for supported targets, everything mentioned above except for combine
is supported
targets.wasm32-unknown-unknown.latest.rust-std
rust-analyzer : derivation
Nightly version of rust-analyzer
, also available with overlay as rust-analyzer-nightly
# configuration.nix with overlay
{ pkgs, ... }: {
environment.systemPackages = with pkgs; [ rust-analyzer-nightly ];
}
rust-analyzer-vscode-extension : derivation
Nightly version of vscode-extensions.rust-lang.rust-analyzer
, also available with overlay as vscode-extensions.rust-lang.rust-analyzer-nightly
# with overlay
with pkgs; vscode-with-extensions.override {
vscodeExtensions = [
vscode-extensions.rust-lang.rust-analyzer-nightly
];
}
platform | target |
---|---|
aarch64-darwin | aarch64-apple-darwin |
aarch64-linux | aarch64-unknown-linux-gnu |
i686-linux | i686-unknown-linux-gnu |
x86_64-darwin | x86_64-apple-darwin |
x86_64-linux | x86_64-unknown-linux-gnu |
only rust-std (for cross compiling)
- aarch64-apple-darwin
- aarch64-apple-ios
- aarch64-linux-android
- aarch64-pc-windows-msvc
- aarch64-unknown-fuchsia
- aarch64-unknown-linux-musl
- arm-linux-androideabi
- arm-unknown-linux-gnueabi
- arm-unknown-linux-gnueabihf
- arm-unknown-linux-musleabi
- arm-unknown-linux-musleabihf
- armv5te-unknown-linux-gnueabi
- armv7-linux-androideabi
- armv7-unknown-linux-gnueabihf
- armv7-unknown-linux-musleabihf
- asmjs-unknown-emscripten
- i586-pc-windows-msvc
- i586-unknown-linux-gnu
- i586-unknown-linux-musl
- i686-linux-android
- i686-pc-windows-gnu
- i686-pc-windows-msvc
- i686-unknown-freebsd
- i686-unknown-linux-musl
- mips-unknown-linux-gnu
- mips-unknown-linux-musl
- mips64-unknown-linux-gnuabi64
- mips64el-unknown-linux-gnuabi64
- mipsel-unknown-linux-gnu
- mipsel-unknown-linux-musl
- powerpc-unknown-linux-gnu
- powerpc64-unknown-linux-gnu
- powerpc64le-unknown-linux-gnu
- s390x-unknown-linux-gnu
- sparc64-unknown-linux-gnu
- sparcv9-sun-solaris
- wasm32-unknown-emscripten
- wasm32-unknown-unknown
- x86_64-apple-ios
- x86_64-linux-android
- x86_64-pc-windows-gnu
- x86_64-pc-windows-msvc
- x86_64-rumprun-netbsd
- x86_64-sun-solaris
- x86_64-unknown-freebsd
- x86_64-unknown-fuchsia
- x86_64-unknown-illumos
- x86_64-unknown-linux-gnux32
- x86_64-unknown-linux-musl
- x86_64-unknown-netbsd
- x86_64-unknown-redox
building with makeRustPlatform
{
inputs = {
fenix = {
url = "github:nix-community/fenix";
inputs.nixpkgs.follows = "nixpkgs";
};
flake-utils.url = "github:numtide/flake-utils";
nixpkgs.url = "nixpkgs/nixos-unstable";
};
outputs = { self, fenix, flake-utils, nixpkgs }:
flake-utils.lib.eachDefaultSystem (system: {
packages.default =
let
toolchain = fenix.packages.${system}.minimal.toolchain;
pkgs = nixpkgs.legacyPackages.${system};
in
(pkgs.makeRustPlatform {
cargo = toolchain;
rustc = toolchain;
}).buildRustPackage {
pname = "example";
version = "0.1.0";
src = ./.;
cargoLock.lockFile = ./Cargo.lock;
};
});
}
building with crane
{
inputs = {
crane = {
url = "github:ipetkov/crane";
inputs = {
flake-utils.follows = "flake-utils";
nixpkgs.follows = "nixpkgs";
};
};
fenix = {
url = "github:nix-community/fenix";
inputs.nixpkgs.follows = "nixpkgs";
};
flake-utils.url = "github:numtide/flake-utils";
nixpkgs.url = "nixpkgs/nixos-unstable";
};
outputs = { self, crane, fenix, flake-utils, nixpkgs }:
flake-utils.lib.eachDefaultSystem (system: {
packages.default =
let
craneLib = crane.lib.${system}.overrideToolchain
fenix.packages.${system}.minimal.toolchain;
in
craneLib.buildPackage {
src = ./.;
};
});
}
cross compiling with naersk
{
inputs = {
fenix = {
url = "github:nix-community/fenix";
inputs.nixpkgs.follows = "nixpkgs";
};
flake-utils.url = "github:numtide/flake-utils";
naersk = {
url = "github:nix-community/naersk";
inputs.nixpkgs.follows = "nixpkgs";
};
nixpkgs.url = "nixpkgs/nixos-unstable";
};
outputs = { self, fenix, flake-utils, naersk, nixpkgs }:
flake-utils.lib.eachDefaultSystem (system: {
packages.default =
let
pkgs = nixpkgs.legacyPackages.${system};
target = "aarch64-unknown-linux-gnu";
toolchain = with fenix.packages.${system}; combine [
minimal.cargo
minimal.rustc
targets.${target}.latest.rust-std
];
in
(naersk.lib.${system}.override {
cargo = toolchain;
rustc = toolchain;
}).buildPackage {
src = ./.;
CARGO_BUILD_TARGET = target;
CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER =
"${pkgs.pkgsCross.aarch64-multiplatform.stdenv.cc}/bin/${target}-gcc";
};
});
}
pinning to a specific version of rust without using IFD
{
inputs = {
fenix = {
url = "github:nix-community/fenix";
inputs.nixpkgs.follows = "nixpkgs";
};
nixpkgs.url = "nixpkgs/nixos-unstable";
rust-manifest = {
url = "https://static.rust-lang.org/dist/2022-02-06/channel-rust.toml";
flake = false;
};
};
outputs = { self, fenix, nixpkgs, rust-manifest }: {
packages.x86_64-linux.default =
(fenix.packages.x86_64-linux.fromManifestFile rust-manifest).minimalToolchain;
};
}
All pull requests should target staging
branch instead of the default main
branch