leptos/any_spawner
Saber Haj Rabiee b3e2040ec9
chore: upgrade dependencies (#2765)
2024-08-10 20:01:41 -04:00
..
src docs: fix cfg for docsrs 2024-08-01 19:43:09 -04:00
Cargo.toml chore: upgrade dependencies (#2765) 2024-08-10 20:01:41 -04:00
Makefile.toml chore(ci): add Makefiles for smaller packages 2024-08-01 19:42:21 -04:00
README.md prep for preview release 2024-08-01 19:40:56 -04:00

README.md

This crate makes it easier to write asynchronous code that is executor-agnostic, by providing a utility that can be used to spawn tasks in a variety of executors.

It only supports single executor per program, but that executor can be set at runtime, anywhere in your crate (or an application that depends on it).

This can be extended to support any executor or runtime that supports spawning [Future]s.

This is a least common denominator implementation in many ways. Limitations include:

  • setting an executor is a one-time, global action
  • no "join handle" or other result is returned from the spawn
  • the Future must output ()
use any_spawner::Executor;

Executor::init_futures_executor()
    .expect("executor should only be initialized once");

// spawn a thread-safe Future
Executor::spawn(async { /* ... */ });

// spawn a Future that is !Send
Executor::spawn_local(async { /* ... */ });