Skip to content

Data structures to connect async with immediate mode guis

License

Notifications You must be signed in to change notification settings

ChrisRega/lazy_async_promise

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

94 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

lazy_async_promise: Simple primitives to manage tokio and egui

Documentation CI Coverage Status License

This crate currently only features simple primitives for getting computation time off the main thread using tokio:

  • LazyVecPromise for a vector-backed storage which can be displayed while the task in progress.
  • LazyValuePromise for a single value future that can be updated during task-progress. My usage was for iterative algorithms where the intermediate results were interesting for display.

As the name suggests the two of them are lazily evaluated and nothing happens until they are polled for the first time.

For single values which are either available or not there's ImmediateValuePromise which triggers computation immediately. There's not in-calculation value read out, so either it's finished or not. After heavy usage, I currently tend to use ImmediateValuePromise wrapped in Option for most lazy values, too. Especially when no intermediate values are needed, it's technically sufficient and simpler. Also, since 0.4.0 it's very convenient to use now, see the docs for examples.

Another example usage of this crate with a small egui/eframe blog-reader can be found here

Changelog:

0.6.0

  • Added get_result and take_result to everything that implements DirectCacheAccess (Thanks @tomellm)

0.5.0

  • Fixed visibility issues with BoxSendError (thanks @aspcartman)
  • Added progress tracked wrapper for immediate value promise (made lazyvaluepromise obsolete at least for me)
  • Updated documentation

0.4.0:

  • Added more flexible API to lazy and immediate structures, allowing to take the values
  • Added DirectCacheAccess trait to make option-based usage of the immediate value promise more convenient
  • Updated documentation

0.3.1:

  • Add better api macros for lazy structures

0.3.0:

  • Removed into_boxed trait in favor of supporting the regular From trait which allows direct usage of the ?-Operator in ImmediateValuePromise
  • Added a progress indicator for the LazyVecPromise and LazyValuePromise
  • Indication is done by Progress strong type which ensures values between 0.0 and 1.0
  • Added CI for mac, windows and linux - had to give test-timings more leeway for mac os than on linux.