Cargo and Conan both produce cross-platform, C-compatibile binaries, and have similar ease-of-use goals. Interoperability is an obvious step.
Let’s take a look at Rust, Cargo and Conan C/C++ package manager, and how they can work together to ease the creation of better Rust code with embedded C code.
Rust packages, Always repeatable?
Extracted from their website:
«Cargo is a tool that allows Rust projects to declare their various dependencies and ensure that you’ll always get a repeatable build.»
But when you are talking about C library dependencies and cross platform support… you may need some help with the “always repeteable” thing and keeping it clean.
The Cargo solution to integrate C code is:
«allowing a package to specify a script (written in Rust) to run before invoking rustc. Rust is leveraged to implement platform-specific configuration and refactor out common build functionality among packages.»
And we really think that is a good approach, but also a big problem if we want to keep our Rust code cross platform.
Conan to the rescue!
Cargo just need to know the following information for the C libraries:
- Which are the libraries we need to link with.
- Where are those libraries.
- Where are the headers of those libraries.
Cargo requires that the build script outputs the assignment of some variables to the appropiate values for the C libraries you want to build, something like this:
So the issue is how retrieve to your computer the required C library, build the binary if needed, and automatically get the include directories, library name and library directories, in a cross-platform way. Conan package manager can do this tasks, and it knows well where are all those paths and libraries, and their link order (very important if you have transitive dependencies)
Moreover the file’s format needed by Cargo is very simple, so it can be easily automated with a conan generator. A conan generator produces an output file that can be consumed by a certain tool. For example conan already has build-in file generators for cmake, visual studio, xcode…etc.
With the recently introduced generator packages, we can create and require a generator in the same way we require a conan package. So we can write our conanfile.txt file with the required dependencies and the cargo generator:
and execute conan install:
Conan has automatically generated a conan_cargo_build.rs file . This file should be ignored in git (or any other vcs), as it will be regenerated with “conan install” command in every clean project.
Edit your Cargo.toml file and specify the build script:
Now build your Cargo project:
Need to add a new C or C++(with C API) dependency? Add it to conanfile.txt and execute conan install
Now yes, we can say that Rust packages cargo builds (using C/C++ code too) are Always repeatable.
You can find the conan-cargo generator and it’s documentation here.