blob: 077383430b70c5d6ea2e4100f1496d7049171033 [file] [log] [blame]
<!--
Documentation generated by Skydoc
-->
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width initial-scale=1" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Overview</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,600,700" type="text/css">
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
<link rel="stylesheet" href="https://code.getmdl.io/1.1.1/material.green-light_blue.min.css">
<script defer src="https://code.getmdl.io/1.1.1/material.min.js"></script>
<link rel="stylesheet" href="https://bazelbuild.github.io/rules_rust/main.css">
</head>
<body>
<div class="mdl-layout mdl-js-layout mdl-layout--fixed-drawer
mdl-layout--fixed-header">
<header class="mdl-layout__header">
<div class="mdl-layout__header-row">
<span class="mdl-layout-title">Overview</span>
</div>
</header>
<div class="mdl-layout__drawer">
<span class="mdl-layout-title">Bazel</span>
<nav class="drawer-nav">
<ul class="drawer-nav">
<li><a href="https://bazelbuild.github.io/rules_rust/index.html">Overview</a></li>
<li>
<a href="https://bazelbuild.github.io/rules_rust/rust/rust.html">Rust Rules</a>
<ul>
<li><a href="https://bazelbuild.github.io/rules_rust/rust/rust.html#overview">Overview</a></li>
<li>
<a href="https://bazelbuild.github.io/rules_rust/rust/rust.html#rust_benchmark">
rust_benchmark
</a>
</li>
<li>
<a href="https://bazelbuild.github.io/rules_rust/rust/rust.html#rust_binary">
rust_binary
</a>
</li>
<li>
<a href="https://bazelbuild.github.io/rules_rust/rust/rust.html#rust_doc">
rust_doc
</a>
</li>
<li>
<a href="https://bazelbuild.github.io/rules_rust/rust/rust.html#rust_doc_test">
rust_doc_test
</a>
</li>
<li>
<a href="https://bazelbuild.github.io/rules_rust/rust/rust.html#rust_library">
rust_library
</a>
</li>
<li>
<a href="https://bazelbuild.github.io/rules_rust/rust/rust.html#rust_test">
rust_test
</a>
</li>
</ul>
</li>
</ul>
</nav>
</div>
<main class="mdl-layout__content">
<div class="page-content">
<h1>Overview</h1>
<nav class="toc">
<h2>Rule sets</h2>
<ul>
<li><a href="#rust">Rust Rules</a></li>
</ul>
</nav>
<h2><a href="https://bazelbuild.github.io/rules_rust/rust/rust.html">Rust Rules</a></h2>
<h3>Rules</h3>
<table class="overview-table">
<colgroup>
<col class="col-name" />
<col class="col-description" />
</colgroup>
<tbody>
<tr>
<td>
<a href="https://bazelbuild.github.io/rules_rust/rust/rust.html#rust_benchmark">
<code>rust_benchmark</code>
</a>
</td>
<td>
<p>Builds a Rust benchmark test.</p>
</td>
</tr>
<tr>
<td>
<a href="https://bazelbuild.github.io/rules_rust/rust/rust.html#rust_binary">
<code>rust_binary</code>
</a>
</td>
<td>
<p>Builds a Rust binary crate.</p>
</td>
</tr>
<tr>
<td>
<a href="https://bazelbuild.github.io/rules_rust/rust/rust.html#rust_doc">
<code>rust_doc</code>
</a>
</td>
<td>
<p>Generates code documentation.</p>
</td>
</tr>
<tr>
<td>
<a href="https://bazelbuild.github.io/rules_rust/rust/rust.html#rust_doc_test">
<code>rust_doc_test</code>
</a>
</td>
<td>
<p>Runs Rust documentation tests.</p>
</td>
</tr>
<tr>
<td>
<a href="https://bazelbuild.github.io/rules_rust/rust/rust.html#rust_library">
<code>rust_library</code>
</a>
</td>
<td>
<p>Builds a Rust library crate.</p>
</td>
</tr>
<tr>
<td>
<a href="https://bazelbuild.github.io/rules_rust/rust/rust.html#rust_test">
<code>rust_test</code>
</a>
</td>
<td>
<p>Builds a Rust test crate.</p>
</td>
</tr>
</tbody>
</table>
<h3>Macros</h3>
<table class="overview-table">
<colgroup>
<col class="col-name" />
<col class="col-description" />
</colgroup>
<tbody>
<tr>
<td>
<a href="https://bazelbuild.github.io/rules_rust/rust/rust.html#rust_repositories">
<code>rust_repositories</code>
</a>
</td>
<td>
<p>Adds the external dependencies needed for the Rust rules.</p>
</td>
</tr>
</tbody>
</table>
</div>
<footer class="mdl-mini-footer">
<div class="mdl-mini-footer__left-section">
<div class="mdl-logo">Bazel</div>
<ul class="mdl-mini-footer__link-list">
<li><a href="http://bazel.io">Home</a></li>
<li><a href="https://github.com/bazelbuild">GitHub</a></li>
</ul>
</div>
</footer>
</main>
</div>
</body>
</html>