chore: add Rust CI and update cssparser dep and lock (#3175)
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
# Rust
|
||||
|
||||
We have added experimental support for intergrating Rust code into the source tree.
|
||||
We have added experimental support for integrating Rust code into the source tree.
|
||||
|
||||
## Rust Bridge
|
||||
|
||||
@@ -16,7 +16,7 @@ When building with CMake, need to have the correct Rust toolchain(s) installed.
|
||||
|
||||
You can use `rustup` to manage toolchains. Which toolchain you needs depends on your host platform and for what platform you are trying to build. If your host and target platform are the same, you probably have the correct toolchain installed after installing Rust. For example when building for **Android** and building on a **x84 Linux** host you would use the following command:
|
||||
|
||||
```
|
||||
```shell
|
||||
rustup target add --toolchain stable-x86_64-unknown-linux-gnu aarch64-linux-android armv7-linux-androideabi i686-linux-android x86_64-linux-android
|
||||
```
|
||||
|
||||
@@ -24,7 +24,7 @@ See [Platform Support](https://doc.rust-lang.org/nightly/rustc/platform-support.
|
||||
|
||||
You also need to have cxxbridge installed:
|
||||
|
||||
```
|
||||
```shell
|
||||
cargo install cxxbridge-cmd
|
||||
```
|
||||
|
||||
@@ -36,10 +36,19 @@ Pass the `--//:use_rust` flag to Bazel commands.
|
||||
|
||||
Note that when [generating an Xcode project](./ios/README.md) you should not pass this option to Bazel directly, but as follows:
|
||||
|
||||
```
|
||||
```shell
|
||||
bazel run //platform/ios:xcodeproj --@rules_xcodeproj//xcodeproj:extra_common_flags="--//:renderer=metal --//:use_rust"
|
||||
```
|
||||
|
||||
## Just
|
||||
|
||||
For the Rust subproject, we suggest installing [just](https://github.com/casey/just#readme), a modern alternative to `make`. The `justfile` in the root directory contains a number of useful commands for building and testing the Rust code. The same commands can be run directly, but `just` provides a more convenient interface.
|
||||
|
||||
* Install `just` with `cargo install just`
|
||||
* Run `just` in the `/rustutils` dir to see a list of available commands
|
||||
* Some common commands: `just check`, `just test`, `just fmt`
|
||||
* To run the same steps as used by CI, run `just ci-test`
|
||||
|
||||
## Creating a new Module
|
||||
|
||||
To create a new module:
|
||||
@@ -47,15 +56,15 @@ To create a new module:
|
||||
1. Add a new source file to `rustutils/src/example.rs`.
|
||||
2. Implement it, see the [CXX documentation](https://cxx.rs/index.html) or see `rustutils/src/color.rs` for an example.
|
||||
3. Create a C++ source file that will use the generated C++ header. See `src/mbgl/util/color.rs.cpp` for an example. Import the generated header with
|
||||
```
|
||||
```cpp
|
||||
#include <rustutils/example.hpp>
|
||||
```
|
||||
4. Conditionally include either the `*.rs.cpp` file or the `*.cpp` file it replaces in CMake and Bazel. Here is what it looks like for CMake:
|
||||
```
|
||||
```cmake
|
||||
${PROJECT_SOURCE_DIR}/src/mbgl/util/color$<IF:$<BOOL:${MLN_USE_RUST}>,.rs.cpp,.cpp>
|
||||
```
|
||||
And here for Bazel:
|
||||
```
|
||||
```bazel
|
||||
select({
|
||||
"//:rust": [
|
||||
"src/mbgl/util/color.rs.cpp",
|
||||
|
||||
Reference in New Issue
Block a user