Struct MainThreadData

pub struct MainThreadData<T>(/* private fields */);

Data that can only be accessed from the main thread. Accessors take a MainThreadToken.

This can be moved freely between threads, but the Drop implementation will panic if it’s dropped from a thread other than the main thread.

Implementations

impl<T> MainThreadData<T>

pub fn new(_: MainThreadToken, data: T) -> Self

Create a new MainThreadData.

pub fn get(&self, _: MainThreadToken) -> &T

Get shared access to this data.

pub fn get_mut(&mut self, _: MainThreadToken) -> &mut T

Get exclusive access to this data.

pub fn get_on_main_thread(&self, callback: impl FnOnce(&T) + Send) -> bool

Get shared access to this data in a callback that’s run on the main thread. This method waits for the callback to complete before returning.

If this is called on a thread other than the main thread, it requires the SDL event loop to run. See SDL_RunOnMainThread for details.

Returns false if the callback failed to run.

See also run_sync_on_main_thread().

pub fn get_mut_on_main_thread( &mut self, callback: impl FnOnce(&mut T) + Send, ) -> bool

Get exclusive access to this data in a callback that’s run on the main thread. This method waits for the callback to complete before returning.

If this is called on a thread other than the main thread, it requires the SDL event loop to run. See SDL_RunOnMainThread for details.

Returns false if the callback failed to run.

See also run_sync_on_main_thread().

Trait Implementations

impl<T> Drop for MainThreadData<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Send for MainThreadData<T>

impl<T> Sync for MainThreadData<T>