Struct MainThreadToken

pub struct MainThreadToken(/* private fields */);

Zero sized token that can only exist on the main thread.

Call MainThreadToken::get() or MainThreadToken::assert() to get one.

Implementations

impl MainThreadToken

pub fn get() -> Option<Self>

Get Some(MainThreadToken) if called on the main thread, or None otherwise. Returns None if MainThreadToken hasn’t been inited.

On targets that don’t support threads, this will always succeed if MainThreadToken has been inited.

See also MainThreadToken::assert()

pub fn assert() -> Self

Get MainThreadToken if called on the main thread, or panic otherwise. Panics if MainThreadToken hasn’t been inited.

On targets that don’t support threads, this will always succeed if MainThreadToken has been inited.

See also MainThreadToken::get()

pub unsafe fn init()

Init and declare the current thread as the main thread.

This doesn’t change what’s the actual main thread, and it’s UB to call this on any thread other than the main thread. MainThreadToken::get() and MainThreadToken::assert() will fail on any thread including the main thread before this function is called.

The main and app_init macros will call this for you.

Safety

It’s undefined behaviour to call this on any thread other than the main thread. On targets that don’t support threads, this is always safe.

Trait Implementations

impl Clone for MainThreadToken

fn clone(&self) -> MainThreadToken

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for MainThreadToken