fork/rules_rust
git clone https://git.julia.blue/fork/rules_rust
482a21cf
gh-pages
1<!DOCTYPE HTML > 2< html lang ="en "class ="light sidebar-visible "dir ="ltr "> 3< head > 4<!-- Book generated using mdBook --> 5< meta charset ="UTF-8 "> 6< title > Introduction - rules_rust</ title > 7 8 9<!-- Custom HTML head --> 10 11< meta name ="description "content =""> 12< meta name ="viewport "content ="width=device-width, initial-scale=1 "> 13< meta name ="theme-color "content ="#ffffff "> 14 15< link rel ="icon "href ="favicon.svg "> 16< link rel ="shortcut icon "href ="favicon.png "> 17< link rel ="stylesheet "href ="css/variables.css "> 18< link rel ="stylesheet "href ="css/general.css "> 19< link rel ="stylesheet "href ="css/chrome.css "> 20< link rel ="stylesheet "href ="css/print.css "media ="> 21 22<!-- Fonts --> 23< link rel ="stylesheet "href ="FontAwesome/css/font-awesome.css "> 24< link rel ="stylesheet "href ="fonts/fonts.css "> 25 26<!-- Highlight.js Stylesheets --> 27< link rel ="stylesheet "href ="highlight.css "> 28< link rel ="stylesheet "href ="tomorrow-night.css "> 29< link rel ="stylesheet "href ="ayu-highlight.css "> 30 31<!-- Custom theme stylesheets --> 32 33 34<!-- Provide site root to javascript --> 35< script > 36var path_to_root = "" ; 37var default_theme = window . matchMedia ( "(prefers-color-scheme: dark)" ). matches ?"navy" :"light" ; 38</ script > 39<!-- Start loading toc.js asap --> 40< script src ="toc.js "></ script > 41</ head > 42< body > 43< div id ="body-container "> 44<!-- Work around some values being stored in localStorage wrapped in quotes --> 45< script > 46try { 47var theme = localStorage . getItem ( 'mdbook-theme' ); 48var sidebar = localStorage . getItem ( 'mdbook-sidebar' ); 49 50if ( theme . startsWith ( '"' ) && theme . endsWith ( '"' )) { 51localStorage . setItem ( 'mdbook-theme' , theme . slice ( 1 , theme . length - 1 )); 52} 53 54if ( sidebar . startsWith ( '"' ) && sidebar . endsWith ( '"' )) { 55localStorage . setItem ( 'mdbook-sidebar' , sidebar . slice ( 1 , sidebar . length - 1 )); 56} 57} catch ( e ) { } 58</ script > 59 60<!-- Set the theme before any content is loaded, prevents flash --> 61< script > 62var theme ; 63try { theme = localStorage . getItem ( 'mdbook-theme' ); } catch ( e ) { } 64if ( theme === null || theme === undefined ) { theme = default_theme ; } 65const html = document . documentElement ; 66html . classList . remove ( 'light' ) 67html . classList . add ( theme ); 68html . classList . add ( "js" ); 69</ script > 70 71< input type ="checkbox "id ="sidebar-toggle-anchor "class ="hidden "> 72 73<!-- Hide / unhide sidebar before it is displayed --> 74< script > 75var sidebar = null ; 76var sidebar_toggle = document . getElementById ( "sidebar-toggle-anchor" ); 77if ( document . body . clientWidth >= 1080 ) { 78try { sidebar = localStorage . getItem ( 'mdbook-sidebar' ); } catch ( e ) { } 79sidebar = sidebar || 'visible' ; 80} else { 81sidebar = 'hidden' ; 82} 83sidebar_toggle . checked = sidebar === 'visible' ; 84html . classList . remove ( 'sidebar-visible' ); 85html . classList . add ( "sidebar-" + sidebar ); 86</ script > 87 88< nav id ="sidebar "class ="sidebar "aria-label ="Table of contents "> 89<!-- populated by js --> 90< mdbook-sidebar-scrollbox class ="sidebar-scrollbox "></ mdbook-sidebar-scrollbox > 91< noscript > 92< iframe class ="sidebar-iframe-outer "src ="toc.html "></ iframe > 93</ noscript > 94< div id ="sidebar-resize-handle "class ="sidebar-resize-handle "> 95< div class ="sidebar-resize-indicator "></ div > 96</ div > 97</ nav > 98 99< div id ="page-wrapper "class ="page-wrapper "> 100 101< div class ="page "> 102< div id ="menu-bar-hover-placeholder "></ div > 103< div id ="menu-bar "class ="menu-bar sticky "> 104< div class ="left-buttons "> 105< 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 "> 106< i class ="fa fa-bars "></ i > 107</ label > 108< 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 "> 109< i class ="fa fa-paint-brush "></ i > 110</ button > 111< ul id ="theme-list "class ="theme-popup "aria-label ="Themes "role ="menu "> 112< li role ="none ">< button role ="menuitem "class ="theme "id ="light "> Light</ button ></ li > 113< li role ="none ">< button role ="menuitem "class ="theme "id ="rust "> Rust</ button ></ li > 114< li role ="none ">< button role ="menuitem "class ="theme "id ="coal "> Coal</ button ></ li > 115< li role ="none ">< button role ="menuitem "class ="theme "id ="navy "> Navy</ button ></ li > 116< li role ="none ">< button role ="menuitem "class ="theme "id ="ayu "> Ayu</ button ></ li > 117</ ul > 118< 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 "> 119< i class ="fa fa-search "></ i > 120</ button > 121</ div > 122 123< h1 class ="menu-title "> rules_rust</ h1 > 124 125< div class ="right-buttons "> 126< a href ="print.html "title ="Print this book "aria-label ="Print this book "> 127< i id ="print-button "class ="fa fa-print "></ i > 128</ a > 129< a href ="https://github.com/bazelbuild/rules_rust "title ="Git repository "aria-label ="Git repository "> 130< i id ="git-repository-button "class ="fa fa-github "></ i > 131</ a > 132 133</ div > 134</ div > 135 136< div id ="search-wrapper "class ="hidden "> 137< form id ="searchbar-outer "class ="searchbar-outer "> 138< input type ="search "id ="searchbar "name ="searchbar "placeholder ="Search this book ... "aria-controls ="searchresults-outer "aria-describedby ="searchresults-header "> 139</ form > 140< div id ="searchresults-outer "class ="searchresults-outer hidden "> 141< div id ="searchresults-header "class ="searchresults-header "></ div > 142< ul id ="searchresults "> 143</ ul > 144</ div > 145</ div > 146 147<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM --> 148< script > 149document . getElementById ( 'sidebar-toggle' ). setAttribute ( 'aria-expanded' , sidebar === 'visible' ); 150document . getElementById ( 'sidebar' ). setAttribute ( 'aria-hidden' , sidebar !== 'visible' ); 151Array . from ( document . querySelectorAll ( '#sidebar a' )). forEach ( function ( link ) { 152link . setAttribute ( 'tabIndex' , sidebar === 'visible' ?0 :- 1 ); 153}); 154</ script > 155 156< div id ="content "class ="content "> 157< main > 158< h1 id ="rules-rust ">< a class ="header "href ="#rules-rust "> Rules Rust</ a ></ h1 > 159< p > This repository provides rules for building< a href ="http://www.rust-lang.org/ "> Rust</ a > projects with< a href ="https://bazel.build/ "> Bazel</ a > .</ p > 160<!-- TODO: Render generated docs on the github pages site again, https://bazelbuild.github.io/rules_rust/ --> 161< p >< a name ="setup "></ a ></ p > 162< h2 id ="setup ">< a class ="header "href ="#setup "> Setup</ a ></ h2 > 163< p > The rules are released, and releases 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 > 164< h3 id ="bzlmod ">< a class ="header "href ="#bzlmod "> Bzlmod</ a ></ h3 > 165< 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 > 166< p > To use< code > rules_rust</ code > in a project using bzlmod, add the following to your< code > MODULE.bazel</ code > file:</ p > 167< pre >< code class ="language-python "> bazel_dep(name = "rules_rust", version = "0.48.0") 168</ code ></ pre > 169< p > Don't forget to substitute in your desired release's version number.</ p > 170< h3 id ="workspace ">< a class ="header "href ="#workspace "> WORKSPACE</ a ></ h3 > 171< p > To use< code > rules_rust</ code > 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 > 172< pre >< code class ="language-python "> load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive") 173 174# To find additional information on this release or newer ones visit: 175# https://github.com/bazelbuild/rules_rust/releases 176http_archive( 177 name = "rules_rust", 178 integrity = "sha256-Weev1uz2QztBlDA88JX6A1N72SucD1V8lBsaliM0TTg=", 179 urls = ["https://github.com/bazelbuild/rules_rust/releases/download/0.48.0/rules_rust-v0.48.0.tar.gz"], 180) 181 182load("@rules_rust//rust:repositories.bzl", "rules_rust_dependencies", "rust_register_toolchains") 183 184rules_rust_dependencies() 185 186rust_register_toolchains() 187</ code ></ pre > 188< p > Don't forget to substitute in your desired release's version number and integrity hash.</ p > 189< h2 id ="specifying-rust-version ">< a class ="header "href ="#specifying-rust-version "> Specifying Rust version</ a ></ h2 > 190< p > To build with a particular version of the Rust compiler, pass that version to< a href ="flatten.html#rust_register_toolchains ">< code > rust_register_toolchains</ code ></ a > :</ p > 191< pre >< code class ="language-python "> rust_register_toolchains( 192 edition = "2021", 193 versions = [ 194 "1.79.0" 195 ], 196) 197</ code ></ pre > 198< p > As well as an exact version,< code > versions</ code > can accept< code > nightly/{iso_date}</ code > and< code > beta/{iso_date}</ code > strings for toolchains from different release channels.</ p > 199< pre >< code class ="language-python "> rust_register_toolchains( 200 edition = "2021", 201 versions = [ 202 "nightly/2024-06-13", 203 ], 204) 205</ code ></ pre > 206< p > By default, a< code > stable</ code > and< code > nightly</ code > toolchain will be registered if no versions are passed to< code > rust_register_toolchains</ code > . However, 207if only 1 version is passed and it is from the< code > nightly</ code > or< code > beta</ code > release channels (i.e.< strong > not</ strong > < code > stable</ code > ), then a build setting must 208also be set in the project's< code > .bazelrc</ code > file.</ p > 209< pre >< code class ="language-text "> build --@rules_rust//rust/toolchain/channel=nightly 210</ code ></ pre > 211< p > Failure to do so will result in rules attempting to match a< code > stable</ code > toolchain when one was not registered.</ p > 212< h2 id ="supported-bazel-versions ">< a class ="header "href ="#supported-bazel-versions "> Supported bazel versions</ a ></ h2 > 213< p > The oldest version of Bazel the< code > main</ code > branch is tested against is< code > 7.3.1</ code > . Previous versions may still be functional in certain environments, but this is the minimum version we strive to fully support.</ p > 214< p > We test these rules against the latest rolling releases of Bazel, and aim for compatibility with them, but prioritise stable releases over rolling releases where necessary.</ p > 215< h2 id ="supported-platforms ">< a class ="header "href ="#supported-platforms "> Supported platforms</ a ></ h2 > 216< p > We aim to support Linux and macOS.</ p > 217< p > We do not have sufficient maintainer expertise to support Windows. Most things probably work, but we have had to disable many tests in CI because we lack the expertise to fix them. We welcome contributions to help improve its support.</ p > 218< p > Windows support for some features requires< code > --enable_runfiles</ code > to be passed to Bazel, we recommend putting it in your bazelrc. See< a href ="https://bazel.build/configure/windows "> Using Bazel on Windows</ a > for more Windows-specific recommendations.</ p > 219 220</ main > 221 222< nav class ="nav-wrapper "aria-label ="Page navigation "> 223<!-- Mobile navigation buttons --> 224 225< a rel ="next prefetch "href ="rules.html "class ="mobile-nav-chapters next "title ="Next chapter "aria-label ="Next chapter "aria-keyshortcuts ="Right "> 226< i class ="fa fa-angle-right "></ i > 227</ a > 228 229< div style ="clear: both "></ div > 230</ nav > 231</ div > 232</ div > 233 234< nav class ="nav-wide-wrapper "aria-label ="Page navigation "> 235 236< a rel ="next prefetch "href ="rules.html "class ="nav-chapters next "title ="Next chapter "aria-label ="Next chapter "aria-keyshortcuts ="Right "> 237< i class ="fa fa-angle-right "></ i > 238</ a > 239</ nav > 240 241</ div > 242 243 244 245 246< script > 247window . playground_copyable = true ; 248</ script > 249 250 251< script src ="elasticlunr.min.js "></ script > 252< script src ="mark.min.js "></ script > 253< script src ="searcher.js "></ script > 254 255< script src ="clipboard.min.js "></ script > 256< script src ="highlight.js "></ script > 257< script src ="book.js "></ script > 258 259<!-- Custom JS scripts --> 260 261 262</ div > 263</ body > 264</ html >