bazel-0.1.2.tar_3.gz

# Rust Rules <div class="toc"> <h2>Rules</h2> <ul> <li><a href="#rust_library">rust_library</a></li> <li><a href="#rust_binary">rust_binary</a></li> <li><a href="#rust_test">rust_test</a></li> <li><a href="#rust_bench_test">rust_bench_test</a></li> <li><a href="#rust_doc">rust_doc</a></li> <li><a href="#rust_doc_test">rust_doc_test</a></li> </ul> </div> ## Overview These build rules are used for building [Rust][rust] projects with Bazel. [rust]: http://www.rust-lang.org/ <a name="setup"></a> ## Setup To use the Rust rules, simply copy the contents of `rust.WORKSPACE` to your `WORKSPACE` file. <a name="roadmap"></a> ## Roadmap * Add `rust_toolchain` rule to make it easy to use a custom Rust toolchain. * Add tool for taking `Cargo.toml` and generating a `WORKSPACE` file with workspace rules for pulling external dependencies. * Improve expressiveness of features and support for [Cargo's feature groups](http://doc.crates.io/manifest.html#the-[features]-section). * Add `cargo_crate` workspace rule for pulling crates from [Cargo](https://crates.io/). <a name="rust_library"></a> ## rust_library ```python rust_library(name, srcs, deps, data, crate_features, rustc_flags) ``` <table class="table table-condensed table-bordered table-params"> <colgroup> <col class="col-param" /> <col class="param-description" /> </colgroup> <thead> <tr> <th colspan="2">Attributes</th> </tr> </thead> <tbody> <tr> <td><code>name</code></td> <td> <code>Name, required</code> <p>A unique name for this rule.</p> <p> This name will also be used as the name of the library crate built by this rule. </p> </td> </tr> <tr> <td><code>srcs</code></td> <td> <code>List of labels, required</code> <p>List of Rust <code>.rs</code> source files used to build the library.</p> <p> If <code>srcs</code> contains more than one file, then there must be a file either named <code>lib.rs</code>. Otherwise, <code>crate_root</code> must be set to the source file that is the root of the crate to be passed to <code>rustc</code> to build this crate. </p> </td> </tr> <tr> <td><code>crate_root</code></td> <td> <code>Label, optional</code> <p> The file that will be passed to <code>rustc</code> to be used for building this crate. </p> <p> If <code>crate_root</code> is not set, then this rule will look for a <code>lib.rs</code> file or the single file in <code>srcs</code> if <code>srcs</code> contains only one file. </p> </td> </td> <tr> <td><code>deps</code></td> <td> <code>List of labels, optional</code> <p>List of other libraries to be linked to this library target.</p> <p> These can be either other <code>rust_library</code> targets or <code>cc_library</code> targets if linking a native library. </p> </td> </tr> <tr> <td><code>data</code></td> <td> <code>List of labels, optional</code> <p>List of files used by this rule at runtime.</p> <p> This attribute can be used to specify any data files that are embedded into the library, such as via the <a href="https://doc.rust-lang.org/std/macro.include_str!.html target="_blank"><code>include_str!</code></a> macro. </p> </td> </tr> <tr> <td><code>crate_features</code></td> <td> <code>List of strings, optional</code> <p>List of features to enable for this crate.</p> <p> Features are defined in the code using the <code>#[cfg(feature = "foo")]</code> configuration option. The features listed here will be passed to <code>rustc</code> with <code>--cfg feature="${feature_name}"</code> flags. </p> </td> </tr> <tr> <td><code>rustc_flags</code></td> <td> <code>List of strings, optional</code> <p>List of compiler flags passed to <code>rustc</code>.</p> </td> </tr> </tbody> </table> ### Example Suppose you have the following directory structure for a simple Rust library crate: ``` [workspace]/ WORKSPACE hello_lib/ BUILD src/ greeter.rs lib.rs ``` `hello_lib/src/greeter.rs`: ```rust pub struct Greeter { greeting: String, } impl Greeter { pub fn new(greeting: &str) -> Greeter { Greeter { greeting: greeting.to_string(), } } pub fn greet(&self, thing: &str) { println!("{} {}", &self.greeting, thing); } } ``` `hello_lib/src/lib.rs`: ```rust pub mod greeter; ``` `hello_lib/BUILD`: ```python package(default_visibility = ["//visibility:public"]) load("/tools/build_rules/rust/rust", "rust_library") rust_library( name = "hello_lib", srcs = [ "src/greeter.rs", "src/lib.rs", ], ) ``` Build the library: ``` $ bazel build //hello_lib INFO: Found 1 target... Target //examples/rust/hello_lib:hello_lib up-to-date: bazel-bin/examples/rust/hello_lib/libhello_lib.rlib INFO: Elapsed time: 1.245s, Critical Path: 1.01s ``` <a name="rust_binary"></a> ## rust_binary ``` rust_binary(name, srcs, deps, data, crate_features, rustc_flags) ``` <table class="table table-condensed table-bordered table-params"> <colgroup> <col class="col-param" /> <col class="param-description" /> </colgroup> <thead> <tr> <th colspan="2">Attributes</th> </tr> </thead> <tbody> <tr> <td><code>name</code></td> <td> <code>Name, required</code> <p>A unique name for this rule.</p> <p> This name will also be used as the name of the binary crate built by this rule. </p> </td> </tr> <tr> <td><code>srcs</code></td> <td> <code>List of labels, required</code> <p>List of Rust <code>.rs</code> source files used to build the binary.</p> <p> If <code>srcs</code> contains more than one file, then there must be a file either named <code>main.rs</code>. Otherwise, <code>crate_root</code> must be set to the source file that is the root of the crate to be passed to <code>rustc</code> to build this crate. </p> </td> </tr> <tr> <td><code>crate_root</code></td> <td> <code>Label, optional</code> <p> The file that will be passed to <code>rustc</code> to be used for building this crate. </p> <p> If <code>crate_root</code> is not set, then this rule will look for a <code>main.rs</code> file or the single file in <code>srcs</code> if <code>srcs</code> contains only one file. </p> </td> </td> <tr> <td><code>deps</code></td> <td> <code>List of labels, optional</code> <p>List of other libraries to be linked to this library target.</p> <p> These must be <code>rust_library</code> targets. </p> </td> </tr> <tr> <td><code>data</code></td> <td> <code>List of labels, optional</code> <p>List of files used by this rule at runtime.</p> <p> This attribute can be used to specify any data files that are embedded into the library, such as via the <a href="https://doc.rust-lang.org/std/macro.include_str!.html target="_blank"><code>include_str!</code></a> macro. </p> </td> </tr> <tr> <td><code>crate_features</code></td> <td> <code>List of strings, optional</code> <p>List of features to enable for this crate.</p> <p>