Attribute Macro thread

#[thread]

Re-export the proc macros. Declares a Zephyr thread (or pool of threads) that can be spawned.

There are some restrictions on this:

• All arguments to the function must be Send.
• The function must not use generics.
• The optional pool_size attribute must be 1 or greater.
• The stack_size must be specified, and will set the size of the pre-defined stack for each task in the pool.

Examples

Declaring a task with a simple argument:

#[zephyr::thread(stack_size = 1024)]
fn mytask(arg: u32) {
    // Function body.
}

The result will be a function mytask that takes this argument, and returns a ReadyThread. A simple use case is to call .start() on this, to start the Zephyr thread.

Threads can be reused after they have exited. Calling the mytask function before the thread has exited will result in a panic. The RunningThread’s join method can be used to wait for thread termination.