| <!DOCTYPE HTML> |
| <html lang="en" class="light sidebar-visible" dir="ltr"> |
| <head> |
| <!-- Book generated using mdBook --> |
| <meta charset="UTF-8"> |
| <title>rust - rules_rust</title> |
| |
| |
| <!-- Custom HTML head --> |
| |
| <meta name="description" content=""> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="theme-color" content="#ffffff"> |
| |
| <link rel="icon" href="favicon.svg"> |
| <link rel="shortcut icon" href="favicon.png"> |
| <link rel="stylesheet" href="css/variables.css"> |
| <link rel="stylesheet" href="css/general.css"> |
| <link rel="stylesheet" href="css/chrome.css"> |
| <link rel="stylesheet" href="css/print.css" media="print"> |
| |
| <!-- Fonts --> |
| <link rel="stylesheet" href="FontAwesome/css/font-awesome.css"> |
| <link rel="stylesheet" href="fonts/fonts.css"> |
| |
| <!-- Highlight.js Stylesheets --> |
| <link rel="stylesheet" href="highlight.css"> |
| <link rel="stylesheet" href="tomorrow-night.css"> |
| <link rel="stylesheet" href="ayu-highlight.css"> |
| |
| <!-- Custom theme stylesheets --> |
| |
| |
| <!-- Provide site root to javascript --> |
| <script> |
| var path_to_root = ""; |
| var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light"; |
| </script> |
| <!-- Start loading toc.js asap --> |
| <script src="toc.js"></script> |
| </head> |
| <body> |
| <div id="body-container"> |
| <!-- Work around some values being stored in localStorage wrapped in quotes --> |
| <script> |
| try { |
| var theme = localStorage.getItem('mdbook-theme'); |
| var sidebar = localStorage.getItem('mdbook-sidebar'); |
| |
| if (theme.startsWith('"') && theme.endsWith('"')) { |
| localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1)); |
| } |
| |
| if (sidebar.startsWith('"') && sidebar.endsWith('"')) { |
| localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1)); |
| } |
| } catch (e) { } |
| </script> |
| |
| <!-- Set the theme before any content is loaded, prevents flash --> |
| <script> |
| var theme; |
| try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { } |
| if (theme === null || theme === undefined) { theme = default_theme; } |
| const html = document.documentElement; |
| html.classList.remove('light') |
| html.classList.add(theme); |
| html.classList.add("js"); |
| </script> |
| |
| <input type="checkbox" id="sidebar-toggle-anchor" class="hidden"> |
| |
| <!-- Hide / unhide sidebar before it is displayed --> |
| <script> |
| var sidebar = null; |
| var sidebar_toggle = document.getElementById("sidebar-toggle-anchor"); |
| if (document.body.clientWidth >= 1080) { |
| try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { } |
| sidebar = sidebar || 'visible'; |
| } else { |
| sidebar = 'hidden'; |
| } |
| sidebar_toggle.checked = sidebar === 'visible'; |
| html.classList.remove('sidebar-visible'); |
| html.classList.add("sidebar-" + sidebar); |
| </script> |
| |
| <nav id="sidebar" class="sidebar" aria-label="Table of contents"> |
| <!-- populated by js --> |
| <mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox> |
| <noscript> |
| <iframe class="sidebar-iframe-outer" src="toc.html"></iframe> |
| </noscript> |
| <div id="sidebar-resize-handle" class="sidebar-resize-handle"> |
| <div class="sidebar-resize-indicator"></div> |
| </div> |
| </nav> |
| |
| <div id="page-wrapper" class="page-wrapper"> |
| |
| <div class="page"> |
| <div id="menu-bar-hover-placeholder"></div> |
| <div id="menu-bar" class="menu-bar sticky"> |
| <div class="left-buttons"> |
| <label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar"> |
| <i class="fa fa-bars"></i> |
| </label> |
| <button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list"> |
| <i class="fa fa-paint-brush"></i> |
| </button> |
| <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu"> |
| <li role="none"><button role="menuitem" class="theme" id="light">Light</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li> |
| <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li> |
| </ul> |
| <button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar"> |
| <i class="fa fa-search"></i> |
| </button> |
| </div> |
| |
| <h1 class="menu-title">rules_rust</h1> |
| |
| <div class="right-buttons"> |
| <a href="print.html" title="Print this book" aria-label="Print this book"> |
| <i id="print-button" class="fa fa-print"></i> |
| </a> |
| <a href="https://github.com/bazelbuild/rules_rust" title="Git repository" aria-label="Git repository"> |
| <i id="git-repository-button" class="fa fa-github"></i> |
| </a> |
| |
| </div> |
| </div> |
| |
| <div id="search-wrapper" class="hidden"> |
| <form id="searchbar-outer" class="searchbar-outer"> |
| <input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header"> |
| </form> |
| <div id="searchresults-outer" class="searchresults-outer hidden"> |
| <div id="searchresults-header" class="searchresults-header"></div> |
| <ul id="searchresults"> |
| </ul> |
| </div> |
| </div> |
| |
| <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM --> |
| <script> |
| document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible'); |
| document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible'); |
| Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) { |
| link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1); |
| }); |
| </script> |
| |
| <div id="content" class="content"> |
| <main> |
| <h1 id="rust-rules"><a class="header" href="#rust-rules">Rust rules</a></h1> |
| <p>The core Rust rules for building and testing libraries, binaries, and procedural |
| macros. Each rule is documented on its own page; this page is an overview of what |
| each rule does and when to use it.</p> |
| <p>All rules are loadable from <code>@rules_rust//rust:defs.bzl</code> or from their individual |
| <code>.bzl</code> file (e.g. <code>@rules_rust//rust:rust_binary.bzl</code>). Loading from the |
| individual file is preferred for new code.</p> |
| <h2 id="core-rules"><a class="header" href="#core-rules">Core rules</a></h2> |
| <p>The rules below are the primary entry points for compiling Rust code. They map |
| directly to the crate types Cargo produces.</p> |
| <ul> |
| <li><a href="./rust_binary.html">rust_binary</a> — Build a Rust executable (<code>--crate-type=bin</code>).</li> |
| <li><a href="./rust_library.html">rust_library</a> — Build an <code>rlib</code> (<code>--crate-type=lib</code>) that |
| other Rust targets can depend on.</li> |
| <li><a href="./rust_static_library.html">rust_static_library</a> — Build a <code>staticlib</code> |
| (<code>--crate-type=staticlib</code>) for linking Rust code into a C/C++ binary.</li> |
| <li><a href="./rust_cdylib_library.html">rust_cdylib_library</a> — Build a <code>cdylib</code> |
| (<code>--crate-type=cdylib</code>) for use as a shared library from C/C++ or other |
| languages.</li> |
| <li><a href="./rust_dylib_library.html">rust_dylib_library</a> — Build a <code>dylib</code> |
| (<code>--crate-type=dylib</code>) for use as a shared library with the unstable Rust ABI.</li> |
| <li><a href="./rust_shared_library.html">rust_shared_library</a> — Convenience alias over |
| <code>rust_cdylib_library</code>.</li> |
| <li><a href="./rust_proc_macro.html">rust_proc_macro</a> — Build a procedural macro crate |
| (<code>--crate-type=proc-macro</code>) that other Rust targets can consume as a compile-time |
| plugin.</li> |
| <li><a href="./rust_test.html">rust_test</a> — Compile and run a Rust test binary. Can wrap a |
| <code>rust_library</code>/<code>rust_binary</code> (via <code>crate = ...</code>) to run its inline <code>#[test]</code>s, |
| or compile a standalone test binary from its own <code>srcs</code>.</li> |
| </ul> |
| <h2 id="additional-rules"><a class="header" href="#additional-rules">Additional rules</a></h2> |
| <p>Non-core rules that ship in the same ruleset:</p> |
| <ul> |
| <li><a href="./rust_library_group.html">rust_library_group</a> — Group several <code>rust_library</code> |
| targets so they can be depended on as a single unit without generating an |
| intermediate <code>rlib</code>.</li> |
| <li><a href="./rust_lint_config.html">rust_lint_config</a> — Declare a reusable set of <code>rustc</code>, |
| <code>clippy</code>, and <code>rustdoc</code> lint levels that can be attached to other rules via |
| their <code>lint_config</code> attribute.</li> |
| <li><a href="./rust_test_suite.html">rust_test_suite</a> — Convenience macro that expands into |
| one <code>rust_test</code> per source file, sharing a common set of dependencies. Useful |
| for <code>tests/**.rs</code> layouts that mirror Cargo's integration-test directory.</li> |
| </ul> |
| <h2 id="related-pages"><a class="header" href="#related-pages">Related pages</a></h2> |
| <p>Rules that layer on top of the core rules live on their own pages:</p> |
| <ul> |
| <li><a href="./rustdoc.html">rustdoc</a> — Generate and test Rust documentation.</li> |
| <li><a href="./clippy.html">clippy</a> — Run <a href="https://github.com/rust-lang/rust-clippy">Clippy</a> |
| over Rust targets.</li> |
| <li><a href="./rustfmt.html">rustfmt</a> — Run <a href="https://github.com/rust-lang/rustfmt">rustfmt</a> |
| over Rust targets.</li> |
| <li><a href="./unpretty.html">unpretty</a> — Emit <code>rustc -Zunpretty=...</code> output for a crate.</li> |
| <li><a href="./cargo.html">cargo</a> — <code>cargo_build_script</code> and related Cargo-compatibility rules.</li> |
| <li><a href="./rust_analyzer.html">rust_analyzer</a> — Generate a <code>rust-project.json</code> file for |
| the <a href="https://rust-analyzer.github.io">rust-analyzer</a> IDE server.</li> |
| <li><a href="./rust_toolchains.html">Rust Toolchains</a> — Declare and register Rust toolchains.</li> |
| </ul> |
| |
| </main> |
| |
| <nav class="nav-wrapper" aria-label="Page navigation"> |
| <!-- Mobile navigation buttons --> |
| <a rel="prev" href="rules.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> |
| <i class="fa fa-angle-left"></i> |
| </a> |
| |
| <a rel="next prefetch" href="rust_binary.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right"> |
| <i class="fa fa-angle-right"></i> |
| </a> |
| |
| <div style="clear: both"></div> |
| </nav> |
| </div> |
| </div> |
| |
| <nav class="nav-wide-wrapper" aria-label="Page navigation"> |
| <a rel="prev" href="rules.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> |
| <i class="fa fa-angle-left"></i> |
| </a> |
| |
| <a rel="next prefetch" href="rust_binary.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right"> |
| <i class="fa fa-angle-right"></i> |
| </a> |
| </nav> |
| |
| </div> |
| |
| |
| |
| |
| <script> |
| window.playground_copyable = true; |
| </script> |
| |
| |
| <script src="elasticlunr.min.js"></script> |
| <script src="mark.min.js"></script> |
| <script src="searcher.js"></script> |
| |
| <script src="clipboard.min.js"></script> |
| <script src="highlight.js"></script> |
| <script src="book.js"></script> |
| |
| <!-- Custom JS scripts --> |
| |
| |
| </div> |
| </body> |
| </html> |
