Manual Setup - Hello wasm-pack! (original) (raw)

1. 1. Introduction
2. 2. Quickstart
3. 3. Prerequisites
4. 1. 3.1. npm (optional)
   2. 3.2. considerations
   3. 3.3. Non-rustup setups
5. 4. Commands
6. 1. 4.1. new
   2. 4.2. build
   3. 4.3. test
   4. 4.4. pack and publish
   5. 4.5. init (DEPRECATED)
7. 5. Tutorials
8. 1. 5.1. Hybrid applications with Webpack
   2. 1. 5.1.1. Getting started
         1. 5.1.2. Using your library
   3. 5.2. npm browser packages
   4. 1. 5.2.1. Getting started
         1. 1. 5.2.1.1. Manual Setup
         2. 5.2.2. Template deep dive
         3. 1. 5.2.2.1. Cargo.toml
               1. 5.2.2.2. src/lib.rs
               2. 5.2.2.3. src/utils.rs
               3. 5.2.2.4. wee_alloc
               4. 5.2.2.5. tests/web.rs
         4. 5.2.3. Building your project
         5. 5.2.4. Testing your project
         6. 5.2.5. Packaging and publishing
         7. 5.2.6. Using your library
9. 6. Cargo.toml Configuration
10. 7. Contributing

This documentation isno longer maintained at this domain, and is now maintained at drager.github.io/wasm-pack instead.

Hello wasm-pack!

Manual Setup

⚠️ This is not the recommended way to start a wasm-pack project! If you ended up here by mistake, go check out our recommended project start.

Step 1: Create a New Rust Library Project

You can create a new Rust project named my-lib using this command.

cargo new --lib my-lib

The --lib flag specifies that the project is a library, which is important because we will be calling this code from JavaScript.

Step 2: Edit your Cargo.toml File Add the wasm-bindgen dependency

You will need to add wasm-bindgen to your Cargo.toml in the dependencies section. wasm-bindgen is a tool that facilitates interoperability between wasm modules and JavaScript.

⚠️ If you are coming from JavaScript, you might note that when we add the dependency there is no ^ or ~ symbol- it looks like we're locking to the 0.2 version. However, that's not the case! In Rust, the ^ is implied.

Add crate-type

Next, add a [lib] section, with a new field named crate-type set to"cdylib". This specifies that the library is a C compatible dynamic library, which helps cargo pass the correct flags to the Rust compiler when targetingwasm32.

After making these changes, your Cargo.toml file should look something like this:

[package]
name = "hello-wasm"
version = "0.1.0"
authors = ["Ashley Williams <ashley666ashley@gmail.com>"]
description = "babby's first wasm package"
license = "MIT OR Apache-2.0"
repository = "https://github.com/ashleygwilliams/hello-wasm"

[lib]
crate-type = ["cdylib"]

[dependencies]
wasm-bindgen="0.2"

Step 3: Write some Rust!

Now that your crate is correctly configured in your Cargo.toml file, the only step left to setup your project is to have some Rust code in your src/lib.rs file.

Browser Example

The template we have gives you a quick "Hello, World" project to use for compiling into a WebAssembly library that you can use in the browser:

# #![allow(unused_variables)]
#fn main() {
extern crate wasm_bindgen;

use wasm_bindgen::prelude::*;

#[wasm_bindgen]
extern {
    fn alert(s: &str);
}

#[wasm_bindgen]
pub fn greet() {
    alert("Hello, World!");
}
#}

And that's it! We'll talk about what this code does in the template deep dive, which you are all setup for now. Happy wasm-packing!