Expand description
Waterark
§Installation
-
Default
[dependencies] waterark = "0.2" -
Using in async runtimes with std
-
tokio[dependencies] waterark = { version = "0.2", default-features = false, features = ["tokio", "std"] } -
smol[dependencies] waterark = { version = "0.2", default-features = false, features = ["smol", "std"] } -
async-std#[dependencies] waterark = { version = "0.2", default-features = false, features = ["async-std", "std"] } -
wasm#[dependencies] waterark = { version = "0.2", default-features = false, features = ["wasm", "std"] }
-
-
Using in async runtimes without std
[dependencies] waterark = { version = "0.2", default-features = false, features = ["alloc", "future"] }
§License
Licensed under either of Apache License, Version 2.0 or MIT license at your option.Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Modules§
- closer
futureorsync - Closer implementations.
- future
future - Asynchronous watermark implementation.
- sync
sync - Synchronous watermark implementation.
Structs§
- Async
StdSpawner async-std - A
AsyncSpawnerthat uses theasync-stdruntime. - Async
Water Mark future - WaterMark is used to keep track of the minimum un-finished index. Typically, an index k becomes
finished or “done” according to a WaterMark once
done(k)has been called - Smol
Spawner smol - A
AsyncSpawnerthat uses thesmolruntime. - Tokio
Spawner tokioandfuture - A
AsyncSpawnerthat uses thetokioruntime. - Wasm
Spawner wasm - A
AsyncSpawnerthat uses thewasm-bindgen-futuresruntime. - Water
Mark sync - WaterMark is used to keep track of the minimum un-finished index. Typically, an index k becomes
finished or “done” according to a WaterMark once
done(k)has been called
Enums§
- Water
Mark Error - Error type for watermark.
Traits§
- Async
Spawner future - A spawner trait for spawning futures.
- Detach
future - Detaches the task related to the join handle to let it keep running in the background.