How do I add Corrosion to my CMake project?

The easiest method is using CMake's FetchContent module, as demonstrated in the README: declare Corrosion with its Git repository and a version tag, make it available, and use corrosion_import_crate to import Rust targets from Cargo.toml.

Can Corrosion handle Rust workspaces with multiple crates?

Yes, Corrosion can import targets from both package and workspace manifests in Cargo.toml, allowing it to manage multi-crate Rust projects seamlessly within CMake.

Is Corrosion stable enough for production use?

Corrosion has active development and CI testing, but as a relatively young project, users should check the release notes for breaking changes and ensure compatibility with their CMake and Rust versions.

Does Corrosion support dynamic libraries from Rust?

Yes, Corrosion can import dynamic libraries (shared libraries) from Rust crates, along with executables and static libraries, enabling flexible linking options in mixed-language builds.

How do I cross-compile Rust code with Corrosion?

Corrosion integrates with CMake's toolchain files to simplify cross-compilation; set up your toolchain for the target platform, and Corrosion will handle the Rust-specific configurations automatically.

Corrosion vs manual CMake scripts for Rust: which is better?

Corrosion automates boilerplate and ensures correct linking, reducing maintenance overhead and errors compared to manual scripts, especially for complex projects, but may add dependency management complexity.

corrosion — CMake Rust Integration Tool

What is corrosion?

Corrosion is a CMake tool that facilitates the integration of Rust code into existing CMake projects, primarily those written in C/C++. It automates the import of Rust crates (executables, static libraries, and dynamic libraries) from Cargo manifests, allowing developers to seamlessly link Rust components with C/C++ code. This solves the problem of manual, error-prone build configuration when combining these languages.

Target Audience

Developers working on mixed-language projects that combine Rust with C/C++, especially those already using CMake as their build system. It is ideal for teams looking to incrementally adopt Rust within an existing codebase.

Value Proposition

Developers choose Corrosion because it automates the complex build integration between Rust and CMake, reducing configuration overhead and ensuring correct linking. Its declarative approach and support for cross-compilation make it a robust, maintainable solution compared to manual scripting or custom build setups.

Marrying Rust and CMake - Easy Rust and C/C++ Integration!

Use Cases

Best For

Incrementally adding Rust modules to a legacy C/C++ CMake project
Building mixed-language applications where Rust libraries need to be linked with C++ executables
Cross-compiling Rust code for embedded systems within a CMake-based workflow
Automating the import of Rust crates as CMake targets for simplified dependency management
Setting up CI/CD pipelines for projects combining Rust and C/C++ with a unified build system
Reducing manual configuration when integrating Rust's safety features into existing C/C++ codebases

Not Ideal For

Projects that do not use CMake as their primary build system
Teams integrating Rust with alternative build systems like Bazel or Meson
Simple Rust-only applications where Cargo suffices and CMake adds unnecessary overhead
Legacy projects locked on CMake versions older than 3.22 (for v0.6)

Pros & Cons

Pros

Automatic Crate Import

Automatically imports Rust executables, static libraries, and dynamic libraries from Cargo.toml, eliminating manual build configuration and reducing errors in mixed-language projects.

Cross-Compilation Support

Provides straightforward cross-compilation for Rust code within CMake, simplifying targeting for embedded systems or multiple platforms without custom scripting.

Seamless C/C++ Linking

Enables trivial linking of Rust targets with in-tree C/C++ libraries, as shown in the README example where a C++ executable links to a Rust library with minimal code.

Multi-Config Generator Compatibility

Supports CMake's multi-configuration generators like Visual Studio, making it suitable for Windows development and complex IDE-based workflows.

Cons

CMake Version Dependency

Requires CMake 3.22 or newer for the latest release, which can hinder adoption in projects with legacy build systems or strict version constraints.

Rust Ecosystem Assumption

Assumes Rust and Cargo are already configured, adding setup complexity for teams primarily familiar with C/C++ and not the Rust toolchain.

Limited Build System Flexibility

Only integrates with CMake, offering no support for other build systems, which may force teams to overhaul their existing infrastructure if they switch.

Frequently Asked Questions

What is corrosion?

Target Audience

Value Proposition

Use Cases

Best For

Incrementally adding Rust modules to a legacy C/C++ CMake project
Building mixed-language applications where Rust libraries need to be linked with C++ executables
Cross-compiling Rust code for embedded systems within a CMake-based workflow
Automating the import of Rust crates as CMake targets for simplified dependency management
Setting up CI/CD pipelines for projects combining Rust and C/C++ with a unified build system
Reducing manual configuration when integrating Rust's safety features into existing C/C++ codebases

Not Ideal For

Projects that do not use CMake as their primary build system
Teams integrating Rust with alternative build systems like Bazel or Meson
Simple Rust-only applications where Cargo suffices and CMake adds unnecessary overhead
Legacy projects locked on CMake versions older than 3.22 (for v0.6)

Pros & Cons

Pros

Automatic Crate Import

Automatically imports Rust executables, static libraries, and dynamic libraries from Cargo.toml, eliminating manual build configuration and reducing errors in mixed-language projects.

Cross-Compilation Support

Provides straightforward cross-compilation for Rust code within CMake, simplifying targeting for embedded systems or multiple platforms without custom scripting.

Seamless C/C++ Linking

Enables trivial linking of Rust targets with in-tree C/C++ libraries, as shown in the README example where a C++ executable links to a Rust library with minimal code.

Multi-Config Generator Compatibility

Supports CMake's multi-configuration generators like Visual Studio, making it suitable for Windows development and complex IDE-based workflows.

Cons

CMake Version Dependency

Requires CMake 3.22 or newer for the latest release, which can hinder adoption in projects with legacy build systems or strict version constraints.

Rust Ecosystem Assumption

Assumes Rust and Cargo are already configured, adding setup complexity for teams primarily familiar with C/C++ and not the Rust toolchain.

Limited Build System Flexibility

Only integrates with CMake, offering no support for other build systems, which may force teams to overhaul their existing infrastructure if they switch.

Frequently Asked Questions

corrosion

What is corrosion?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

corrosion

What is corrosion?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?