We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent d1fa6ca commit a33a62aCopy full SHA for a33a62a
src/lib.rs
@@ -26,6 +26,10 @@ type IoResult<T> = std::io::Result<T>;
26
27
/// Implementataion of a [`StorageBackend`] which delegates to [OPFS] when built for wasm.
28
///
29
+/// **IMPORTANT**: This can only ever be used within a web worker.
30
+/// This _may_ instantiate within the main thread, but as it blocks internally,
31
+/// it will fail at runtime on the main thread if you attempt to actually use it.
32
+///
33
/// In native contexts, this targets the local file system.
34
35
/// [OPFS]: https://developer.mozilla.org/en-US/docs/Web/API/File_System_API/Origin_private_file_system
0 commit comments