Struct async_cpupool::CpuPool

pub struct CpuPool { /* private fields */ }

The CPUPool handle

Implementations

impl CpuPool

pub fn new() -> Self

Create a new CpuPool with the default configuration

Example:

let pool = CpuPool::new();

pub fn configure() -> Config

Create a configuration builder to customize the CpuPool

Example:

let pool = CpuPool::configure().build()?;

pub fn spawn<F, T>( &self, send_fn: F ) -> impl Future<Output = Result<T, Canceled>> + '_

where F: FnOnce() -> T + Send + 'static, T: Send + 'static,

Spawn a blocking operation on the CpuPool

Example:

let pool = CpuPool::new();

pool.spawn(|| std::thread::sleep(std::time::Duration::from_secs(3))).await?;

pub async fn close(self) -> bool

Attempt to close the CpuPool

This operation returns true when the pool was succesfully closed, or false if there exist other references to the pool, preventing closure.

It is not required to call close to close a CpuPool. CpuPools will automatically close themselves when all clones are dropped. This is simply a method to integrate better with async runtimes. Example:

let pool = CpuPool::new();

let closed = pool.close().await;
assert!(closed);

Trait Implementations

impl Clone for CpuPool

fn clone(&self) -> CpuPool

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CpuPool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CpuPool

fn default() -> Self

Returns the “default value” for a type.