Struct smolscale::immortal::Immortal

pub struct Immortal(/* private fields */);

Immortal represents a task that can never stop, unless it is explicity cancelled or dropped from the outside. We can think of this as a Task<!>, except with some nice convenience methods.

Implementations

impl Immortal

pub fn spawn<F: Future<Output = Infallible> + Send + 'static>(f: F) -> Self

Directly spawns an immortal future.

pub fn respawn<T: Send, F: Future<Output = T> + Send>( strategy: RespawnStrategy, inner: impl FnMut() -> F + Send + 'static ) -> Self

Spawns an immortal that runs a piece of code repeatedly, restarting when it returns using a particular restart strategy.

pub async fn cancel(self)

Takes ownership of the immortal and cancels it, waiting only when it has fully stopped running.

Unless you need to wait until the immortal stops before doing something else, it’s easier to just drop this immortal rather than using this method.