Struct smolscale::Nursery

pub struct Nursery { /* fields omitted */ }

A nursery represents a dynamic scope in which tasks can be spawned. It is used for structured concurrency, and it ensures that tasks spawned within the nursery terminate before the nursery falls out of scope.

We intentionally force all futures spawned in the nursery to return anyhow::Result<()>, and we do not expose join handles. This encourages a CSP-style anonymous-process way of thinking, and integration with anyhow allows for powerful error-propagation techniques.

Spawning is done through a NurseryHandle, which is clonable, rather than the Nursery itself. Nursery Deref's into a NurseryHandle so that you can spawn from Nursery as well.

Implementations

impl Nursery

pub fn new() -> Self

Creates a new nursery

pub fn handle(&self) -> NurseryHandle

To handle

pub async fn wait(self) -> Result<()>

Waits for the tasks in the nursery to terminate. If any errors are propagated, immediately returns the error, terminating the whole nursery.

This function asynchronously blocks until all NurseryHandles are dropped.

pub fn wait_sync(self) -> Result<()>

Helper function that waits for nursery tasks synchronously.

Methods from Deref<Target = NurseryHandle>

pub fn spawn<F: Future<Output = Result<()>> + Send + 'static>(
    &self,
    on_error: OnError,
    task_gen: impl FnOnce(NurseryHandle) -> F + Send + 'static
)

Spawns a task in the nursery, using the given recovery strategy. Takes a closure that returns a future because the task may be restarted on failure.

Trait Implementations

impl Default for Nursery

pub fn default() -> Self

Returns the "default value" for a type.

impl Deref for Nursery

type Target = NurseryHandle

The resulting type after dereferencing.

pub fn deref(&self) -> &Self::Target

Dereferences the value.