Struct Task 

pub struct Task<T> { /* private fields */ }

A handle to a spawned task.

This is a wrapper around tokio’s JoinHandle that provides a consistent API.

When awaited, returns Result<T, TaskError>:

• Ok(T): The task completed successfully
• Err(TaskError): The task panicked or was aborted/cancelled

Example

use sansio_executor::{LocalExecutorBuilder, spawn_local};

LocalExecutorBuilder::default().run(async {
    let task = spawn_local(async { 42 });
    let result = task.await.unwrap();
    assert_eq!(result, 42);
});

Implementations

impl<T> Task<T>

pub fn detach(self)

Detaches the task, allowing it to run in the background.

This consumes the task handle and allows the task to continue running without being awaited. The task will run to completion in the background.

Example

use sansio_executor::{LocalExecutorBuilder, spawn_local};

LocalExecutorBuilder::default().run(async {
    let task = spawn_local(async {
        println!("Running in background");
    });

    // Detach the task - it continues running
    task.detach();

    // We can't await it anymore, but it will complete
});

pub fn cancel(self)

Cancels the task.

This immediately aborts the task’s execution.

Example

use sansio_executor::{LocalExecutorBuilder, spawn_local};

LocalExecutorBuilder::default().run(async {
    let task = spawn_local(async {
        println!("This will not print");
    });

    // Cancel the task
    task.cancel();
});

Trait Implementations

impl<T> Future for Task<T>

type Output = Result<T, TaskError>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.