Struct MainThreadToken 

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

A witness of execution that exists solely on a designated “Main Thread”.

In FFI contexts, many libraries (especially legacy C++ or UI frameworks) are not thread-safe and must only be initialized, called, or dropped from the same thread that originally created them.

MainThreadToken is a zero-sized proof carrier. Possessing it proves (at a type-system level) that you are currently executing on the designated main thread.

Implementations

impl MainThreadToken

pub unsafe fn new_unchecked() -> Self

Create a new MainThreadToken.

Safety

This must only be called from the designated main application thread. In VT Code, this is typically the thread that initializes the TUI or the first boot thread.

pub fn try_new() -> Option<Self>

Obtain a token if we are on the main thread, or return None if we are not.

This provides a safe runtime check before performing hazardous FFI operations.

Trait Implementations

impl Clone for MainThreadToken

fn clone(&self) -> MainThreadToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MainThreadToken

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for MainThreadToken

fn eq(&self, other: &MainThreadToken) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for MainThreadToken

impl Eq for MainThreadToken

impl StructuralPartialEq for MainThreadToken