-
Notifications
You must be signed in to change notification settings - Fork 442
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deploying to gh-pages from @ 2bad96d 🚀
- Loading branch information
1 parent
39680ef
commit a2b83b7
Showing
16 changed files
with
2,672 additions
and
3,120 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,236 @@ | ||
| <!DOCTYPE HTML> | ||
| <html lang="en" class="light sidebar-visible" dir="ltr"> | ||
| <head> | ||
| <!-- Book generated using mdBook --> | ||
| <meta charset="UTF-8"> | ||
| <title>Extensions - 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="extensions"><a class="header" href="#extensions">Extensions</a></h1> | ||
| <p>Bazel rules for interfacing with other rules and integrations with popular 3rd party tools.</p> | ||
| <h2 id="setup"><a class="header" href="#setup">Setup</a></h2> | ||
| <p>The extension rules are released with each release of <code>rules_rust</code> (core) which can be found on <a href="https://github.com/bazelbuild/rules_rust/releases">the GitHub Releases page</a>. We recommend using the latest release from that page.</p> | ||
| <h3 id="bzlmod"><a class="header" href="#bzlmod">Bzlmod</a></h3> | ||
| <p>Note that rules_rust bzlmod support is still a work in progress. Most features should work, but bugs are more likely. This is not a desired end-state - please report (or better yet, help fix!) bugs you run into.</p> | ||
| <p>To use <code>rules_rust</code> extensions in a project using bzlmod, add the following to your <code>MODULE.bazel</code> file:</p> | ||
| <pre><code class="language-python">bazel_dep(name = "rules_rust_{EXTENSION}", version = "{VERSION}") | ||
| </code></pre> | ||
| <p>Don't forget to substitute in your desired release's version number and <code>{EXTENSION}</code> with the | ||
| name of the desired extension. E.g.:</p> | ||
| <pre><code class="language-python">bazel_dep(name = "rules_rust_bindgen", version = "0.55.0") | ||
| </code></pre> | ||
| <h3 id="workspace"><a class="header" href="#workspace">WORKSPACE</a></h3> | ||
| <p>To use <code>rules_rust</code> extensions in a project using a WORKSPACE file, add the following to your <code>WORKSPACE</code> file to add the external repositories for the Rust toolchain:</p> | ||
| <pre><code class="language-python">load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive") | ||
|
|
||
| # To find additional information on this release or newer ones visit: | ||
| # https://github.com/bazelbuild/rules_rust/releases | ||
| http_archive( | ||
| name = "rules_rust_{EXTENSION}", | ||
| # See releases page | ||
| ) | ||
|
|
||
| # Refer to the documentation of the desired rules for how to load other necessary dependencies. | ||
| </code></pre> | ||
| <p>Don't forget to substitute in your desired release's version number, integrity hash, and <code>{EXTENSION}</code> with the name of the desired extension.</p> | ||
|
|
||
| </main> | ||
|
|
||
| <nav class="nav-wrapper" aria-label="Page navigation"> | ||
| <!-- Mobile navigation buttons --> | ||
| <a rel="prev" href="upstream_tooling.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_bindgen.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="upstream_tooling.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_bindgen.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> |
Oops, something went wrong.