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 > rustdoc - 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-doc ">< a class ="header "href ="#rust-doc "> Rust Doc</ a ></ h1 > 160< ul > 161< li >< a href ="#rust_doc "> rust_doc</ a ></ li > 162< li >< a href ="#rust_doc_test "> rust_doc_test</ a ></ li > 163</ ul > 164< p >< a id ="rust_doc "></ a ></ p > 165< h2 id ="rust_doc ">< a class ="header "href ="#rust_doc "> rust_doc</ a ></ h2 > 166< pre > 167rust_doc(< a href ="#rust_doc-name "> name</ a > ,< a href ="#rust_doc-crate "> crate</ a > ,< a href ="#rust_doc-html_after_content "> html_after_content</ a > ,< a href ="#rust_doc-html_before_content "> html_before_content</ a > ,< a href ="#rust_doc-html_in_header "> html_in_header</ a > ,< a href ="#rust_doc-markdown_css "> markdown_css</ a > , 168< a href ="#rust_doc-rustc_flags "> rustc_flags</ a > ,< a href ="#rust_doc-rustdoc_flags "> rustdoc_flags</ a > ) 169</ pre > 170< p > Generates code documentation.</ p > 171< p > Example: 172Suppose you have the following directory structure for a Rust library crate:</ p > 173< pre >< code > [workspace]/ 174 WORKSPACE 175 hello_lib/ 176 BUILD 177 src/ 178 lib.rs 179</ code ></ pre > 180< p > To build< a href ="https://doc.rust-lang.org/book/documentation.html ">< code > rustdoc</ code ></ a > documentation for the< code > hello_lib</ code > crate, define a< code > rust_doc</ code > rule that depends on the the< code > hello_lib</ code > < code > rust_library</ code > target:</ p > 181< pre >< code class ="language-python "> package(default_visibility = ["//visibility:public"]) 182 183load("@rules_rust//rust:defs.bzl", "rust_library", "rust_doc") 184 185rust_library( 186 name = "hello_lib", 187 srcs = ["src/lib.rs"], 188) 189 190rust_doc( 191 name = "hello_lib_doc", 192 crate = ":hello_lib", 193) 194</ code ></ pre > 195< p > Running< code > bazel build //hello_lib:hello_lib_doc</ code > will build a zip file containing the documentation for the< code > hello_lib</ code > library crate generated by< code > rustdoc</ code > .</ p > 196< p >< strong > ATTRIBUTES</ strong ></ p > 197< 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 > 198< tr >< td style ="text-align: left ">< a id ="rust_doc-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 > 199< tr >< td style ="text-align: left ">< a id ="rust_doc-crate "></ a > crate</ td >< td style ="text-align: left "> The label of the target to generate code documentation for.< br >< br >< code > rust_doc</ code > can generate HTML code documentation for the source files of< code > rust_library</ code > or< code > rust_binary</ code > targets.</ 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 > 200< tr >< td style ="text-align: left ">< a id ="rust_doc-html_after_content "></ a > html_after_content</ td >< td style ="text-align: left "> File to add in< code > <body></ code > , after content.</ 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 > 201< tr >< td style ="text-align: left ">< a id ="rust_doc-html_before_content "></ a > html_before_content</ td >< td style ="text-align: left "> File to add in< code > <body></ code > , before content.</ 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 > 202< tr >< td style ="text-align: left ">< a id ="rust_doc-html_in_header "></ a > html_in_header</ td >< td style ="text-align: left "> File to add to< code > <head></ code > .</ 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 > 203< tr >< td style ="text-align: left ">< a id ="rust_doc-markdown_css "></ a > markdown_css</ td >< td style ="text-align: left "> CSS files to include via< code > <link></ code > in a rendered Markdown file.</ 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 > 204< tr >< td style ="text-align: left ">< a id ="rust_doc-rustc_flags "></ a > rustc_flags</ td >< td style ="text-align: left ">< strong > Deprecated</ strong > : use< code > rustdoc_flags</ code > instead</ td >< td style ="text-align: left "> List of strings</ td >< td style ="text-align: left "> optional</ td >< td style ="text-align: left ">< code > []</ code ></ td ></ tr > 205< tr >< td style ="text-align: left ">< a id ="rust_doc-rustdoc_flags "></ a > rustdoc_flags</ td >< td style ="text-align: left "> List of flags passed to< code > rustdoc</ code > .< br >< br > These strings are subject to Make variable expansion for predefined source/output path variables like< code > $location</ code > ,< code > $execpath</ code > , and< code > $rootpath</ code > . This expansion is useful if you wish to pass a generated file of arguments to rustc:< code > @$(location //package:target)</ code > .</ td >< td style ="text-align: left "> List of strings</ td >< td style ="text-align: left "> optional</ td >< td style ="text-align: left ">< code > []</ code ></ td ></ tr > 206</ tbody ></ table > 207</ div > 208< p >< a id ="rust_doc_test "></ a ></ p > 209< h2 id ="rust_doc_test ">< a class ="header "href ="#rust_doc_test "> rust_doc_test</ a ></ h2 > 210< pre > 211rust_doc_test(< a href ="#rust_doc_test-name "> name</ a > ,< a href ="#rust_doc_test-deps "> deps</ a > ,< a href ="#rust_doc_test-crate "> crate</ a > ,< a href ="#rust_doc_test-proc_macro_deps "> proc_macro_deps</ a > ) 212</ pre > 213< p > Runs Rust documentation tests.</ p > 214< p > Example:</ p > 215< p > Suppose you have the following directory structure for a Rust library crate:</ p > 216< pre >< code class ="language-output "> [workspace]/ 217WORKSPACE 218hello_lib/ 219 BUILD 220 src/ 221 lib.rs 222</ code ></ pre > 223< p > To run< a href ="https://doc.rust-lang.org/book/documentation.html#documentation-as-tests "> documentation tests</ a > for the< code > hello_lib</ code > crate, define a< code > rust_doc_test</ code > target that depends on the< code > hello_lib</ code > < code > rust_library</ code > target:</ p > 224< pre >< code class ="language-python "> package(default_visibility = ["//visibility:public"]) 225 226load("@rules_rust//rust:defs.bzl", "rust_library", "rust_doc_test") 227 228rust_library( 229 name = "hello_lib", 230 srcs = ["src/lib.rs"], 231) 232 233rust_doc_test( 234 name = "hello_lib_doc_test", 235 crate = ":hello_lib", 236) 237</ code ></ pre > 238< p > Running< code > bazel test //hello_lib:hello_lib_doc_test</ code > will run all documentation tests for the< code > hello_lib</ code > library crate.</ p > 239< p >< strong > ATTRIBUTES</ strong ></ p > 240< 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 > 241< tr >< td style ="text-align: left ">< a id ="rust_doc_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 > 242< tr >< td style ="text-align: left ">< a id ="rust_doc_test-deps "></ a > deps</ td >< td style ="text-align: left "> List of other libraries to be linked to this library target.< br >< br > These can be either other< code > rust_library</ code > targets or< code > cc_library</ code > targets if linking a native library.</ 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 > 243< tr >< td style ="text-align: left ">< a id ="rust_doc_test-crate "></ a > crate</ td >< td style ="text-align: left "> The label of the target to generate code documentation for.< code > rust_doc_test</ code > can generate HTML code documentation for the source files of< code > rust_library</ code > or< code > rust_binary</ code > targets.</ 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 > 244< tr >< td style ="text-align: left ">< a id ="rust_doc_test-proc_macro_deps "></ a > proc_macro_deps</ td >< td style ="text-align: left "> List of< code > rust_proc_macro</ code > targets used to help build this library target.</ 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 > 245</ tbody ></ table > 246</ div > 247</ main > 248 249< nav class ="nav-wrapper "aria-label ="Page navigation "> 250<!-- Mobile navigation buttons --> 251< a rel ="prev "href ="rust.html "class ="mobile-nav-chapters previous "title ="Previous chapter "aria-label ="Previous chapter "aria-keyshortcuts ="Left "> 252< i class ="fa fa-angle-left "></ i > 253</ a > 254 255< a rel ="next prefetch "href ="rust_clippy.html "class ="mobile-nav-chapters next "title ="Next chapter "aria-label ="Next chapter "aria-keyshortcuts ="Right "> 256< i class ="fa fa-angle-right "></ i > 257</ a > 258 259< div style ="clear: both "></ div > 260</ nav > 261</ div > 262</ div > 263 264< nav class ="nav-wide-wrapper "aria-label ="Page navigation "> 265< a rel ="prev "href ="rust.html "class ="nav-chapters previous "title ="Previous chapter "aria-label ="Previous chapter "aria-keyshortcuts ="Left "> 266< i class ="fa fa-angle-left "></ i > 267</ a > 268 269< a rel ="next prefetch "href ="rust_clippy.html "class ="nav-chapters next "title ="Next chapter "aria-label ="Next chapter "aria-keyshortcuts ="Right "> 270< i class ="fa fa-angle-right "></ i > 271</ a > 272</ nav > 273 274</ div > 275 276 277 278 279< script > 280window . playground_copyable = true ; 281</ script > 282 283 284< script src ="elasticlunr.min.js "></ script > 285< script src ="mark.min.js "></ script > 286< script src ="searcher.js "></ script > 287 288< script src ="clipboard.min.js "></ script > 289< script src ="highlight.js "></ script > 290< script src ="book.js "></ script > 291 292<!-- Custom JS scripts --> 293 294 295</ div > 296</ body > 297</ html >