Skip to content

Commit e5f3dc6

Browse files
committed
explain in docs the multi-threaded executor woes that led to the release of 0.4.0
1 parent 2efffe7 commit e5f3dc6

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ version = "0.3.4"
44
edition = "2021"
55
readme = "README.md"
66
documentation = "https://docs.rs/indexed-db"
7-
description = "Bindings to IndexedDB that default the transactions to aborting"
7+
description = "Bindings to IndexedDB that default the transactions to aborting and can work multi-threaded"
88
license = "MIT OR Apache-2.0"
99
repository = "https://github.com/Ekleog/indexed-db"
1010
keywords = ["wasm", "indexeddb", "async", "web", "webassembly"]

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# indexed-db
22

3-
Bindings for IndexedDB, that default transaction to aborting.
3+
Bindings for IndexedDB, that default transaction to aborting and can work multi-threaded.
44

55
## Why yet another IndexedDB crate?
66

77
As of the time of my writing this crate, the alternatives have the default IndexedDB behavior of transaction committing. This is because IndexedDB transactions have strange committing semantics: they commit as soon as the application returns to the event loop without an ongoing request.
88

99
This crate forces your transactions to respect the IndexedDB requirements, so as to make it possible to abort transactions upon errors, rather than having them auto-commit.
1010

11+
Incidentally, this crate, at the time of publishing version 0.4.0, is the only IndexedDB crate that works fine under the multi-threaded executor of `wasm-bindgen`. You can find all the details in [this thread](https://github.com/rustwasm/wasm-bindgen/issues/3798).
12+
1113
## Error handling
1214

1315
This crate uses an `Error<Err>` type. The `Err` generic argument is present on basically all the structs exposed by this crate. It is the type of users in code surrounding `indexed-db` usage, for convenience.

0 commit comments

Comments
 (0)