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 > rustfmt - 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<!-- Generated with Stardoc: http://skydoc.bazel.build --> 159< h1 id ="rust-fmt ">< a class ="header "href ="#rust-fmt "> Rust Fmt</ a ></ h1 > 160< ul > 161< li >< a href ="#rustfmt_aspect "> rustfmt_aspect</ a ></ li > 162< li >< a href ="#rustfmt_test "> rustfmt_test</ a ></ li > 163< li >< a href ="#rustfmt_toolchain "> rustfmt_toolchain</ a ></ li > 164</ ul > 165< h2 id ="overview ">< a class ="header "href ="#overview "> Overview</ a ></ h2 > 166< p >< a href ="https://github.com/rust-lang/rustfmt#readme "> Rustfmt</ a > is a tool for formatting Rust code according to style guidelines. 167By default, Rustfmt uses a style which conforms to the< a href ="https://github.com/rust-lang-nursery/fmt-rfcs/blob/master/guide/guide.md "> Rust style guide</ a > that 168has been formalized through the< a href ="https://github.com/rust-lang-nursery/fmt-rfcs "> style RFC process</ a > . A complete list of all 169configuration options can be found in the< a href ="https://rust-lang.github.io/rustfmt/ "> Rustfmt GitHub Pages</ a > .</ p > 170< h3 id ="setup ">< a class ="header "href ="#setup "> Setup</ a ></ h3 > 171< p > Formatting your Rust targets' source code requires no setup outside of loading< code > rules_rust</ code > 172in your workspace. Simply run< code > bazel run @rules_rust//:rustfmt</ code > to format source code.</ p > 173< p > In addition to this formatter, a simple check can be performed using the< a href ="#rustfmt-aspect "> rustfmt_aspect</ a > aspect by running</ p > 174< pre >< code class ="language-text "> bazel build --aspects=@rules_rust//rust:defs.bzl%rustfmt_aspect --output_groups=rustfmt_checks 175</ code ></ pre > 176< p > Add the following to a< code > .bazelrc</ code > file to enable this check during the build phase.</ p > 177< pre >< code class ="language-text "> build --aspects=@rules_rust//rust:defs.bzl%rustfmt_aspect 178build --output_groups=+rustfmt_checks 179</ code ></ pre > 180< p > It's recommended to only enable this aspect in your CI environment so formatting issues do not 181impact user's ability to rapidly iterate on changes.</ p > 182< p > The< code > rustfmt_aspect</ code > also uses a< code > --@rules_rust//rust/settings:rustfmt.toml</ code > setting which determines the 183< a href ="https://rust-lang.github.io/rustfmt/ "> configuration file</ a > used by the formatter (< code > @rules_rust//tools/rustfmt</ code > ) and the aspect 184(< code > rustfmt_aspect</ code > ). This flag can be added to your< code > .bazelrc</ code > file to ensure a consistent config 185file is used whenever< code > rustfmt</ code > is run:</ p > 186< pre >< code class ="language-text "> build --@rules_rust//rust/settings:rustfmt.toml=//:rustfmt.toml 187</ code ></ pre > 188< h3 id ="tips ">< a class ="header "href ="#tips "> Tips</ a ></ h3 > 189< p > Any target which uses Bazel generated sources will cause the< code > @rules_rust//tools/rustfmt</ code > tool to fail with 190< code > failed to resolve mod `MOD`</ code > . To avoid failures,< a href ="https://rust-lang.github.io/rustfmt/?version=v1.6.0&search=skip_chil#skip_children ">< code > skip_children = true</ code ></ a > 191is recommended to be set in the workspace's< code > rustfmt.toml</ code > file which allows rustfmt to run on these targets 192without failing.</ p > 193< p >< a id ="rustfmt_test "></ a ></ p > 194< h2 id ="rustfmt_test ">< a class ="header "href ="#rustfmt_test "> rustfmt_test</ a ></ h2 > 195< pre > 196rustfmt_test(< a href ="#rustfmt_test-name "> name</ a > ,< a href ="#rustfmt_test-targets "> targets</ a > ) 197</ pre > 198< p > A test rule for performing< code > rustfmt --check</ code > on a set of targets</ p > 199< p >< strong > ATTRIBUTES</ strong ></ p > 200< div class ="table-wrapper ">< table >< thead >< tr >< th style ="text-align: left "> Name</ th >< th style ="text-align: left "> Description</ th >< th style ="text-align: left "> Type</ th >< th style ="text-align: left "> Mandatory</ th >< th style ="text-align: left "> Default</ th ></ tr ></ thead >< tbody > 201< tr >< td style ="text-align: left ">< a id ="rustfmt_test-name "></ a > name</ td >< td style ="text-align: left "> A unique name for this target.</ td >< td style ="text-align: left ">< a href ="https://bazel.build/concepts/labels#target-names "> Name</ a ></ td >< td style ="text-align: left "> required</ td >< td style ="text-align: left "></ td ></ tr > 202< tr >< td style ="text-align: left ">< a id ="rustfmt_test-targets "></ a > targets</ td >< td style ="text-align: left "> Rust targets to run< code > rustfmt --check</ code > on.</ td >< td style ="text-align: left ">< a href ="https://bazel.build/concepts/labels "> List of labels</ a ></ td >< td style ="text-align: left "> optional</ td >< td style ="text-align: left ">< code > []</ code ></ td ></ tr > 203</ tbody ></ table > 204</ div > 205< p >< a id ="rustfmt_toolchain "></ a ></ p > 206< h2 id ="rustfmt_toolchain ">< a class ="header "href ="#rustfmt_toolchain "> rustfmt_toolchain</ a ></ h2 > 207< pre > 208rustfmt_toolchain(< a href ="#rustfmt_toolchain-name "> name</ a > ,< a href ="#rustfmt_toolchain-rustc "> rustc</ a > ,< a href ="#rustfmt_toolchain-rustc_lib "> rustc_lib</ a > ,< a href ="#rustfmt_toolchain-rustfmt "> rustfmt</ a > ) 209</ pre > 210< p > A toolchain for< a href ="https://rust-lang.github.io/rustfmt/ "> rustfmt</ a ></ p > 211< p >< strong > ATTRIBUTES</ strong ></ p > 212< div class ="table-wrapper ">< table >< thead >< tr >< th style ="text-align: left "> Name</ th >< th style ="text-align: left "> Description</ th >< th style ="text-align: left "> Type</ th >< th style ="text-align: left "> Mandatory</ th >< th style ="text-align: left "> Default</ th ></ tr ></ thead >< tbody > 213< tr >< td style ="text-align: left ">< a id ="rustfmt_toolchain-name "></ a > name</ td >< td style ="text-align: left "> A unique name for this target.</ td >< td style ="text-align: left ">< a href ="https://bazel.build/concepts/labels#target-names "> Name</ a ></ td >< td style ="text-align: left "> required</ td >< td style ="text-align: left "></ td ></ tr > 214< tr >< td style ="text-align: left ">< a id ="rustfmt_toolchain-rustc "></ a > rustc</ td >< td style ="text-align: left "> The location of the< code > rustc</ code > binary. Can be a direct source or a filegroup containing one item.</ td >< td style ="text-align: left ">< a href ="https://bazel.build/concepts/labels "> Label</ a ></ td >< td style ="text-align: left "> optional</ td >< td style ="text-align: left ">< code > None</ code ></ td ></ tr > 215< tr >< td style ="text-align: left ">< a id ="rustfmt_toolchain-rustc_lib "></ a > rustc_lib</ td >< td style ="text-align: left "> The libraries used by rustc during compilation.</ td >< td style ="text-align: left ">< a href ="https://bazel.build/concepts/labels "> Label</ a ></ td >< td style ="text-align: left "> optional</ td >< td style ="text-align: left ">< code > None</ code ></ td ></ tr > 216< tr >< td style ="text-align: left ">< a id ="rustfmt_toolchain-rustfmt "></ a > rustfmt</ td >< td style ="text-align: left "> The location of the< code > rustfmt</ code > binary. Can be a direct source or a filegroup containing one item.</ td >< td style ="text-align: left ">< a href ="https://bazel.build/concepts/labels "> Label</ a ></ td >< td style ="text-align: left "> required</ td >< td style ="text-align: left "></ td ></ tr > 217</ tbody ></ table > 218</ div > 219< p >< a id ="rustfmt_aspect "></ a ></ p > 220< h2 id ="rustfmt_aspect ">< a class ="header "href ="#rustfmt_aspect "> rustfmt_aspect</ a ></ h2 > 221< pre > 222rustfmt_aspect(< a href ="#rustfmt_aspect-name "> name</ a > ) 223</ pre > 224< p > This aspect is used to gather information about a crate for use in rustfmt and perform rustfmt checks</ p > 225< p > Output Groups:</ p > 226< ul > 227< li >< code > rustfmt_checks</ code > : Executes< code > rustfmt --check</ code > on the specified target.</ li > 228</ ul > 229< p > The build setting< code > @rules_rust//rust/settings:rustfmt.toml</ code > is used to control the Rustfmt< a href ="https://rust-lang.github.io/rustfmt/ "> configuration settings</ a > 230used at runtime.</ p > 231< p > This aspect is executed on any target which provides the< code > CrateInfo</ code > provider. However 232users may tag a target with< code > no-rustfmt</ code > or< code > no-format</ code > to have it skipped. Additionally, 233generated source files are also ignored by this aspect.</ p > 234< p >< strong > ASPECT ATTRIBUTES</ strong ></ p > 235< p >< strong > ATTRIBUTES</ strong ></ p > 236< div class ="table-wrapper ">< table >< thead >< tr >< th style ="text-align: left "> Name</ th >< th style ="text-align: left "> Description</ th >< th style ="text-align: left "> Type</ th >< th style ="text-align: left "> Mandatory</ th >< th style ="text-align: left "> Default</ th ></ tr ></ thead >< tbody > 237< tr >< td style ="text-align: left ">< a id ="rustfmt_aspect-name "></ a > name</ td >< td style ="text-align: left "> A unique name for this target.</ td >< td style ="text-align: left ">< a href ="https://bazel.build/concepts/labels#target-names "> Name</ a ></ td >< td style ="text-align: left "> required</ td >< td style ="text-align: left "></ td ></ tr > 238</ tbody ></ table > 239</ div > 240</ main > 241 242< nav class ="nav-wrapper "aria-label ="Page navigation "> 243<!-- Mobile navigation buttons --> 244< a rel ="prev "href ="rust_clippy.html "class ="mobile-nav-chapters previous "title ="Previous chapter "aria-label ="Previous chapter "aria-keyshortcuts ="Left "> 245< i class ="fa fa-angle-left "></ i > 246</ a > 247 248< a rel ="next prefetch "href ="cargo.html "class ="mobile-nav-chapters next "title ="Next chapter "aria-label ="Next chapter "aria-keyshortcuts ="Right "> 249< i class ="fa fa-angle-right "></ i > 250</ a > 251 252< div style ="clear: both "></ div > 253</ nav > 254</ div > 255</ div > 256 257< nav class ="nav-wide-wrapper "aria-label ="Page navigation "> 258< a rel ="prev "href ="rust_clippy.html "class ="nav-chapters previous "title ="Previous chapter "aria-label ="Previous chapter "aria-keyshortcuts ="Left "> 259< i class ="fa fa-angle-left "></ i > 260</ a > 261 262< a rel ="next prefetch "href ="cargo.html "class ="nav-chapters next "title ="Next chapter "aria-label ="Next chapter "aria-keyshortcuts ="Right "> 263< i class ="fa fa-angle-right "></ i > 264</ a > 265</ nav > 266 267</ div > 268 269 270 271 272< script > 273window . playground_copyable = true ; 274</ script > 275 276 277< script src ="elasticlunr.min.js "></ script > 278< script src ="mark.min.js "></ script > 279< script src ="searcher.js "></ script > 280 281< script src ="clipboard.min.js "></ script > 282< script src ="highlight.js "></ script > 283< script src ="book.js "></ script > 284 285<!-- Custom JS scripts --> 286 287 288</ div > 289</ body > 290</ html >