rustwasm/book

Add a section about common memory management patterns between wasm and JS

Open

#79 opened on Aug 23, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Handlebars (215 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (1,832 stars)
PR merge metrics
 (PR metrics pending)

Description

This would be a new reference sub-section.

Things to mention:

  • Dynamically allocated objects owned by JS must be manually freed by JS

  • To help alleviate that pain, mention the JS equivalent of RAII:

    function withResource(f) {
    let resource = new Resource();
    try {
        return f(resource);
    } finally {
        resource.free();
    }
}

    also the async version of that, with return await f(resource);

  • Static globals in rust that don't need to have their lifetime managed by JS

  • Mention upcoming GC weakrefs, link to tracking page, explain their relevance to cleaning up objects in wasm

  • Mayyyybe mention how one could build reference counting in JS of dynamically allocated wasm objects? I don't know of anyone actually doing this, so maybe not mention it until then?

Anything else?

Contributor guide

Research direction
Study the existing Rust and WebAssembly book structure, then write a new subsection on memory management patterns covering: dynamically allocated objects owned by JS must be manually freed, JS equivalent of RAII with try finally, static globals in Rust, GC weakrefs, and optionally reference counting.
Tech stack
rustjavascript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RustJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75