Attribute Macro tokio_macros::main

source · []
#[main]
Expand description

Marks async function to be executed by selected runtime. This macro helps set up a Runtime without requiring the user to use Runtime or Builder directly.

Options:

  • basic_scheduler - All tasks are executed on the current thread.
  • threaded_scheduler - Uses the multi-threaded scheduler. Used by default (requires rt-threaded feature).

Function arguments:

Arguments are allowed for any functions aside from main which is special

Usage

Using default

#[tokio::main]
async fn main() {
    println!("Hello world");
}

Equivalent code not using #[tokio::main]

fn main() {
    tokio::runtime::Runtime::new()
        .unwrap()
        .block_on(async {
            println!("Hello world");
        })
}

Select runtime

#[tokio::main(basic_scheduler)]
async fn main() {
    println!("Hello world");
}

Equivalent code not using #[tokio::main]

fn main() {
    tokio::runtime::Builder::new()
        .basic_scheduler()
        .enable_all()
        .build()
        .unwrap()
        .block_on(async {
            println!("Hello world");
        })
}

NOTE:

If you rename the tokio crate in your dependencies this macro will not work. If you must rename the 0.2 version of tokio because you’re also using the 0.1 version of tokio, you must make the tokio 0.2 crate available as tokio in the module where this macro is expanded.