https://github.com/ealmloff/sledgehammer

https://github.com/ealmloff/sledgehammer

Last synced: about 8 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/ealmloff/sledgehammer
• Owner: ealmloff
• License: mit
• Archived: true
• Created: 2022-09-18T01:25:14.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-05-20T01:40:07.000Z (over 1 year ago)
• Last Synced: 2024-10-29T08:27:55.265Z (18 days ago)
• Language: Rust
• Size: 4.98 MB
• Stars: 189
• Watchers: 5
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  
sledgehammer





  

  

    

  

  

  

    

  

  

  

    

  



# Development of this library has stoped in favor of [Sledgehammer Bindgen](https://github.com/Demonthos/sledgehammer_bindgen) which is a generalized version of this concept that works with non-DOM focused instruction sets.

**Breaking the WASM<->JS performance boundary one brick at a time**

### Status: There are some holes in the wall.

# What is Sledgehammer?

Sledgehammer provides faster rust bindings for dom manipulations by batching calls to js.

# Benchmarks

- js-framework-benchmark that trusts the implementation and only measures dom operation time (not paint time):

https://demonthos.github.io/wasm_bindgen_sledgehammer/

This gives more consistent results than the official js-framework-benchmark because it excludes the variation in paint time. Because sledgehammer and wasm-bindgen implementations result in the same dom calls, they should have the same paint time.

- The official js-framework-benchmark results



  



# How does this compare to wasm-bindgen/web-sys:

wasm-bindgen is a lot more general, and ergonomic to use than sledgehammer. It has bindings to a lot of apis that sledgehammer does not. For most users wasm-bindgen is a beter choice. Sledgehammer is specifically designed for web frameworks that want low-level, fast access to the dom.

# Why is it fast?

## String decoding

- Decoding strings are expensive to decode, but the cost doesn't change much with the size of the string. Wasm-bindgen calls TextDecoder.decode for every string. Sledgehammer only calls TextEncoder.decode once per batch.

- If the string is small, it is faster to decode the string in javascript to avoid the constant overhead of TextDecoder.decode

- See this benchmark: https://jsbench.me/4vl97c05lb/5

## Single byte attributes and elements

- In addition to making string decoding cheaper, sledgehammer also uses fewer strings. All elements and attribute names are encoded as a single byte instead of a string and then turned back into a string in the javascript interpreter.

- To allow for custom elements and attributes, you can pass in a &str instead of an Attribute or Element enum.

## Byte encoded operations

- In sledgehammer every operation is encoded as a sequence of bytes packed into an array. Every operation takes 1 byte plus whatever data is required for it.

- Booleans are encoded as part of the operation byte to reduce the number of bytes read.

- Each operation is encoded in a batch of four as a u32. Getting a number from an array buffer has a high constant cost, but getting a u32 instead of a u8 is not more expensive. Sledgehammer reads the u32 and then splits it into the 4 individual bytes.

- See this benchmark: https://jsbench.me/csl9lfauwi/2

## Minimize passing ids

- A common set of operations for webframeworks to perform is traversing dom nodes after cloning them. Instead of assigning an id to every node, sledgehammer allows you to perform operations on the last node that was created or navigated to. This means traversing id takes only one byte per operation instead of 5.