Hello,
I have a project for which some machines have only a subset of features set. Currently, I write
cargo run --no-default-features --features "toto,titi" --bin my_bin
This is a bit cumbersome and I sometimes forget the --no-default-features --features part.
I was wondering if there is a local config file that I could put in the directory to instruct cargo to use this particular subset of features.
I guess this should be in the documentation, but I didn’t find it.
The way I can think of to do this is to make a program called
cargo-build-envwhich reads a file of your choosing with the features and executes cargo, then place that binary in your~/.cargo/bindirectory. Then you can runcargo build-envto build your programThe program can be in any language as long as it’s executable, including shell script
Yeah, a simple bash script should do. Such as:
#!/usr/bin/env bash BUILD_FEATURES=${BUILD_FEATURES:=default} cargo run --no-default-features --features "${BUILD_FEATURES}" --bin my_binThen just set a BUILD_FEATURES env var.
A couple options come to mind to me:
- Only have default features that every platform will support. This way you don’t need to opt-out, instead you always opt-in per platform.
- Use other conditions in
cfgmore. If your features are conditional based on OS, architecture, CPU features, etc then you probably are better off using conditions other thanfeature. See the reference for more information. - Use a separate build script. Cargo doesn’t scale well by itself for larger projects, so separate scripts which run cargo are common. You could use Makefile, shell scripts, or even look into tools like
cargo-makeandjust. From there, you can do platform-specific build logic or even read variables from a.envlike you mentioned you wanted.
Going opt-in instead of opt-out does not change the fact that I would still have to toggle the features manually. To be more specific, my use case is that I have a program to control cameras in my lab. But not all computers have the libraries for all cameras. So, every supported library can be enable/disable using a feature But the program being still in active development, I am frequently using
cargo run,cargo check,cargo install, on different computers with different libraries installed. What would be convenient would be to have a configuration file on each computer, specifying that we will build only for PCO camera on this computer, only for Photometrics camera on this one, only Ximea and PCO on this one, instead of having to remember to toggle the relevant features every time. A shell script is not very convenient because I use different commands, run, check, install etc.You should look at the tools I linked.
cargo-makewould just change your flow tocargo make run,cargo make check, etc. andjusthas similar benefits. You’d handle the computer-specific logic in there, using a .env per computer if you want.Ok, I’ll look into that then. Thanks.
You can setup a cargo configuration file, in it you put a manifest and define some profiles, and in them define what features you want compiled
This would look like it would be what I am looking for, but the documentation of the configuration file does not mention features.
https://doc.rust-lang.org/cargo/reference/manifest.html
it’s the sixth from the bottom in the table of contents
It is indeed in the manifest reference, but not in the configuration reference from https://doc.rust-lang.org/cargo/reference/config.html#configuration-format. I have tried anyway to create a
.cargo/config.tomlfile at the project root, with the content[features] default = []but cargo does not seem to take it into account.
Not cargo, but I use justfiles in all my projects: https://github.com/casey/just Its great for aliasing project-specific commands like what you have.
