Trait heim_common::prelude::futures::task::Spawn

pub trait Spawn {
    pub fn spawn_obj(
        &self, 
        future: FutureObj<'static, ()>
    ) -> Result<(), SpawnError>;

    pub fn status(&self) -> Result<(), SpawnError> { ... }
}

The Spawn trait allows for pushing futures onto an executor that will run them to completion.

Required methods

pub fn spawn_obj(
    &self,
    future: FutureObj<'static, ()>
) -> Result<(), SpawnError>

Spawns a future that will be run to completion.

Errors

The executor may be unable to spawn tasks. Spawn errors should represent relatively rare scenarios, such as the executor having been shut down so that it is no longer able to accept tasks.

Loading content...

Provided methods

pub fn status(&self) -> Result<(), SpawnError>

Determines whether the executor is able to spawn new tasks.

This method will return Ok when the executor is likely (but not guaranteed) to accept a subsequent spawn attempt. Likewise, an Err return means that spawn is likely, but not guaranteed, to yield an error.

Loading content...

Implementations on Foreign Types

impl<Sp> Spawn for Rc<Sp> where
    Sp: Spawn + ?Sized, 

pub fn spawn_obj(
    &self,
    future: FutureObj<'static, ()>
) -> Result<(), SpawnError>

pub fn status(&self) -> Result<(), SpawnError>

impl<'_, Sp> Spawn for &'_ Sp where
    Sp: Spawn + ?Sized, 

pub fn spawn_obj(
    &self,
    future: FutureObj<'static, ()>
) -> Result<(), SpawnError>

pub fn status(&self) -> Result<(), SpawnError>

impl<Sp> Spawn for Box<Sp, Global> where
    Sp: Spawn + ?Sized, 

pub fn spawn_obj(
    &self,
    future: FutureObj<'static, ()>
) -> Result<(), SpawnError>

pub fn status(&self) -> Result<(), SpawnError>

impl<Sp> Spawn for Arc<Sp> where
    Sp: Spawn + ?Sized, 

pub fn spawn_obj(
    &self,
    future: FutureObj<'static, ()>
) -> Result<(), SpawnError>

pub fn status(&self) -> Result<(), SpawnError>

impl<'_, Sp> Spawn for &'_ mut Sp where
    Sp: Spawn + ?Sized, 

pub fn spawn_obj(
    &self,
    future: FutureObj<'static, ()>
) -> Result<(), SpawnError>

pub fn status(&self) -> Result<(), SpawnError>

Loading content...

Implementors

impl<'_> Spawn for FuturesUnordered<FutureObj<'_, ()>>

pub fn spawn_obj(
    &self,
    future_obj: FutureObj<'static, ()>
) -> Result<(), SpawnError>

Loading content...