Skip to content

Manage the default rust futures threadpool executor

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

xermicus/poolparty

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cargo Documentation

Tiny crate providing added functionality to the futures-rs threadpool executor. The futures::future::ThreadPool executor currently has no way built in to handle panics, manually stop the pool execution or bubble up errors back to the caller. The crate works around these limitations (it might get obsolete once this open issue will be resolved).

Use cases for the crate are:

  • Stop executing futures in case any of future that runs on it faces an unrecoverable error and returns an Err().
  • Let the caller handle the error.
  • Stop the threadpool and its spawned tasks on user request.

⚠ This crate is beeing passively maintained. It works just fine for me in an existing project. However I'll be using smol as my futures executor in new projects. The smol task handles offer the same functionality (and more), rendering this crate obsolete.

Usage

The following example demonstrates the handling of a failing task:

async fn forever() -> Result<(),String> {
    loop {}
}

async fn fail(msg: String) -> Result<(),String> {
    Err(msg)
}

let mut pool = StoppableThreadPool::new()?;
let err = "fail_function_called".to_string();
pool.spawn(fail(err.clone()));
pool.spawn(forever());

assert_eq!(
    pool.observe().await.unwrap_err(),
    err
)

Have a look at the tests in lib.rs for more usage examples.

License

This project is licensed under either of

at your option.

Contribution

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

About

Manage the default rust futures threadpool executor

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Packages

No packages published

Languages