yield-progress

Crates.ioyield-progress
lib.rsyield-progress
version0.1.6
sourcesrc
created_at2023-08-23 22:02:33.795932
updated_at2024-04-28 20:00:52.282208
descriptionCombined progress reporting and cooperative task yielding.
homepage
repositoryhttps://github.com/kpreid/yield-progress
max_upload_size
id952771
size62,453
Kevin Reid (kpreid)

documentation

README

YieldProgress

This library, yield-progress, provides the YieldProgress type, which allows a long-running async task to report its progress, while also yielding to the scheduler (e.g. for the single-threaded web/Wasm environment) and introducing cancellation points.

These things go together because the rate at which it makes sense to yield (to avoid event loop hangs) is similar to the rate at which it makes sense to report progress, at least for human interfaces.

Compatibility

  • YieldProgress is executor-independent; when it is constructed, the caller may provide a function for yielding using executor-specific mechanisms such as tokio::task::yield_now(), or may use the built-in simple yielder.
  • The library is no_std compatible if default features are disabled. See the library documentation for details on the consequences.

Project status and stability

yield-progress has been split out of my larger project all-is-cubes so that I can use it for other applications; its functionality and applicability may be limited, but I believe it is free of bugs.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Commit count: 53

cargo fmt