fork/rules_rust
git clone https://git.julia.blue/fork/rules_rust
ba7abedc
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 > wasm_bindgen - 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 ="rules_rust_wasm_bindgen ">< a class ="header "href ="#rules_rust_wasm_bindgen "> rules_rust_wasm_bindgen</ a ></ h1 > 160< p > Bazel rules for generating wasm modules for Javascript using< a href ="https://github.com/rustwasm/wasm-bindgen "> wasm-bindgen</ a > .</ p > 161< h2 id ="rules ">< a class ="header "href ="#rules "> Rules</ a ></ h2 > 162< ul > 163< li >< a href ="#rust_wasm_bindgen "> rust_wasm_bindgen</ a ></ li > 164< li >< a href ="#rust_wasm_bindgen_toolchain "> rust_wasm_bindgen_toolchain</ a ></ li > 165</ ul > 166< h2 id ="setup ">< a class ="header "href ="#setup "> Setup</ a ></ h2 > 167< p > To begin using the< code > wasm-bindgen</ code > rules, users can load the necessary dependencies 168in their workspace by adding the following to their< code > WORKSPACE.bazel</ code > file.</ p > 169< pre >< code class ="language-python "> load("@rules_rust_wasm_bindgen//:repositories.bzl", "rust_wasm_bindgen_dependencies", "rust_wasm_bindgen_register_toolchains") 170 171rust_wasm_bindgen_dependencies() 172 173rust_wasm_bindgen_register_toolchains() 174</ code ></ pre > 175< p > This should enable users to start using the< a href ="#rust_wasm_bindgen "> rust_wasm_bindgen</ a > 176rule. However, it's common to want to control the version of< code > wasm-bindgen</ code > in the 177workspace instead of relying on the one provided by< code > rules_rust</ code > . In this case, users 178should avoid calling< code > rust_wasm_bindgen_register_toolchains</ code > and instead use the 179< a href ="#rust_wasm_bindgen_toolchain "> rust_wasm_bindgen_toolchain</ a > rule to define their own 180toolchains to register in the workspace.</ p > 181< h2 id ="interfacing-with-javascript-rules ">< a class ="header "href ="#interfacing-with-javascript-rules "> Interfacing with Javascript rules</ a ></ h2 > 182< p > While it's recommended for users to mantain their own , in the 183< code > @rules_rust_wasm_bindgen</ code > package there exists interface sub-packages for various 184Javascript Bazel rules. E.g.< code > aspect_rules_js</ code > . The rules defined there are a more 185convenient way to use< code > rust_wasm_bindgen</ code > with the associated javascript rules due 186to the inclusion of additional providers. Each directory contains a< code > defs.bzl</ code > file 187that defines the different variants of< code > rust_wasm_bindgen</ code > . (e.g.< code > js_rust_wasm_bindgen</ code > 188for the< code > rules_js</ code > submodule).</ p > 189< p >< a id ="rust_wasm_bindgen "></ a ></ p > 190< h2 id ="rust_wasm_bindgen ">< a class ="header "href ="#rust_wasm_bindgen "> rust_wasm_bindgen</ a ></ h2 > 191< pre > 192rust_wasm_bindgen(< a href ="#rust_wasm_bindgen-name "> name</ a > ,< a href ="#rust_wasm_bindgen-bindgen_flags "> bindgen_flags</ a > ,< a href ="#rust_wasm_bindgen-target "> target</ a > ,< a href ="#rust_wasm_bindgen-target_arch "> target_arch</ a > ,< a href ="#rust_wasm_bindgen-wasm_file "> wasm_file</ a > ) 193</ pre > 194< p > Generates javascript and typescript bindings for a webassembly module using< a href ="https://rustwasm.github.io/docs/wasm-bindgen/ "> wasm-bindgen</ a > .</ p > 195< p > An example of this rule in use can be seen at< a href ="../examples/wasm "> @rules_rust//examples/wasm</ a ></ 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_wasm_bindgen-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_wasm_bindgen-bindgen_flags "></ a > bindgen_flags</ td >< td style ="text-align: left "> Flags to pass directly to the bindgen executable. See https://github.com/rustwasm/wasm-bindgen/ for details.</ 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 > 200< tr >< td style ="text-align: left ">< a id ="rust_wasm_bindgen-target "></ a > target</ td >< td style ="text-align: left "> The type of output to generate. See https://rustwasm.github.io/wasm-bindgen/reference/deployment.html for details.</ td >< td style ="text-align: left "> String</ td >< td style ="text-align: left "> optional</ td >< td style ="text-align: left ">< code > "bundler"</ code ></ td ></ tr > 201< tr >< td style ="text-align: left ">< a id ="rust_wasm_bindgen-target_arch "></ a > target_arch</ td >< td style ="text-align: left "> The target architecture to use for the wasm-bindgen command line option.</ td >< td style ="text-align: left "> String</ td >< td style ="text-align: left "> optional</ td >< td style ="text-align: left ">< code > "wasm32"</ code ></ td ></ tr > 202< tr >< td style ="text-align: left ">< a id ="rust_wasm_bindgen-wasm_file "></ a > wasm_file</ td >< td style ="text-align: left "> The< code > .wasm</ code > file or crate to generate bindings for.</ 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 > 203</ tbody ></ table > 204</ div > 205< p >< a id ="rust_wasm_bindgen_toolchain "></ a ></ p > 206< h2 id ="rust_wasm_bindgen_toolchain ">< a class ="header "href ="#rust_wasm_bindgen_toolchain "> rust_wasm_bindgen_toolchain</ a ></ h2 > 207< pre > 208rust_wasm_bindgen_toolchain(< a href ="#rust_wasm_bindgen_toolchain-name "> name</ a > ,< a href ="#rust_wasm_bindgen_toolchain-bindgen "> bindgen</ a > ) 209</ pre > 210< p > The tools required for the< code > rust_wasm_bindgen</ code > rule.</ p > 211< p > In cases where users want to control or change the version of< code > wasm-bindgen</ code > used by< a href ="#rust_wasm_bindgen "> rust_wasm_bindgen</ a > , 212a unique toolchain can be created as in the example below:</ p > 213< pre >< code class ="language-python "> load("@rules_rust_bindgen//:defs.bzl", "rust_bindgen_toolchain") 214 215rust_bindgen_toolchain( 216 bindgen = "//3rdparty/crates:wasm_bindgen_cli__bin", 217) 218 219toolchain( 220 name = "wasm_bindgen_toolchain", 221 toolchain = "wasm_bindgen_toolchain_impl", 222 toolchain_type = "@rules_rust_wasm_bindgen//:toolchain_type", 223) 224</ code ></ pre > 225< p > Now that you have your own toolchain, you need to register it by 226inserting the following statement in your< code > WORKSPACE</ code > file:</ p > 227< pre >< code class ="language-python "> register_toolchains("//my/toolchains:wasm_bindgen_toolchain") 228</ code ></ pre > 229< p > For additional information, see the< a href ="https://docs.bazel.build/versions/master/toolchains.html "> Bazel toolchains documentation</ a > .</ p > 230< p >< strong > ATTRIBUTES</ strong ></ p > 231< 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 > 232< tr >< td style ="text-align: left ">< a id ="rust_wasm_bindgen_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 > 233< tr >< td style ="text-align: left ">< a id ="rust_wasm_bindgen_toolchain-bindgen "></ a > bindgen</ td >< td style ="text-align: left "> The label of a< code > wasm-bindgen-cli</ code > executable.</ 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 > 234</ tbody ></ table > 235</ div > 236< p >< a id ="RustWasmBindgenInfo "></ a ></ p > 237< h2 id ="rustwasmbindgeninfo ">< a class ="header "href ="#rustwasmbindgeninfo "> RustWasmBindgenInfo</ a ></ h2 > 238< pre > 239RustWasmBindgenInfo(< a href ="#RustWasmBindgenInfo-js "> js</ a > ,< a href ="#RustWasmBindgenInfo-ts "> ts</ a > ,< a href ="#RustWasmBindgenInfo-wasm "> wasm</ a > ) 240</ pre > 241< p > Info about wasm-bindgen outputs.</ p > 242< p >< strong > FIELDS</ strong ></ p > 243< div class ="table-wrapper ">< table >< thead >< tr >< th style ="text-align: left "> Name</ th >< th style ="text-align: left "> Description</ th ></ tr ></ thead >< tbody > 244< tr >< td style ="text-align: left ">< a id ="RustWasmBindgenInfo-js "></ a > js</ td >< td style ="text-align: left "> Depset[File]: The Javascript files produced by< code > wasm-bindgen</ code > .</ td ></ tr > 245< tr >< td style ="text-align: left ">< a id ="RustWasmBindgenInfo-ts "></ a > ts</ td >< td style ="text-align: left "> Depset[File]: The Typescript files produced by< code > wasm-bindgen</ code > .</ td ></ tr > 246< tr >< td style ="text-align: left ">< a id ="RustWasmBindgenInfo-wasm "></ a > wasm</ td >< td style ="text-align: left "> File: The< code > .wasm</ code > file generated by< code > wasm-bindgen</ code > .</ td ></ tr > 247</ tbody ></ table > 248</ div > 249</ main > 250 251< nav class ="nav-wrapper "aria-label ="Page navigation "> 252<!-- Mobile navigation buttons --> 253< a rel ="prev "href ="rust_protobuf.html "class ="mobile-nav-chapters previous "title ="Previous chapter "aria-label ="Previous chapter "aria-keyshortcuts ="Left "> 254< i class ="fa fa-angle-left "></ i > 255</ a > 256 257 258< div style ="clear: both "></ div > 259</ nav > 260</ div > 261</ div > 262 263< nav class ="nav-wide-wrapper "aria-label ="Page navigation "> 264< a rel ="prev "href ="rust_protobuf.html "class ="nav-chapters previous "title ="Previous chapter "aria-label ="Previous chapter "aria-keyshortcuts ="Left "> 265< i class ="fa fa-angle-left "></ i > 266</ a > 267 268</ nav > 269 270</ div > 271 272 273 274 275< script > 276window . playground_copyable = true ; 277</ script > 278 279 280< script src ="elasticlunr.min.js "></ script > 281< script src ="mark.min.js "></ script > 282< script src ="searcher.js "></ script > 283 284< script src ="clipboard.min.js "></ script > 285< script src ="highlight.js "></ script > 286< script src ="book.js "></ script > 287 288<!-- Custom JS scripts --> 289 290 291</ div > 292</ body > 293</ html >