Struct Shared

struct Shared {
    data: Mutex<Data>,
    thread_condvar: Condvar,
}

Shared state and ancillary information

This is always within an Arc.

Fields

data: Mutex<Data>

Shared state

thread_condvar: Condvar

Condition variable for thread scheduling

Signaled when Data.thread_to_run is modified.

Implementations

impl Shared

fn subthread_entrypoint<T: Send + 'static>( self: Arc<Self>, id: TaskId, call: impl FnOnce() -> T + Send + 'static, output_tx: Sender<Result<T, Box<dyn Any + Send>>>, )

Main entrypoint function for a Subthread

Entered on a new std::thread thread created by subthread_spawn.

When call completes, sends its returned value T to output_tx.

fn subthread_yield(&self, us: TaskId, set_awake: Option<SetAwake>)

Yield back to the executor from a subthread

Checks that things are in order (in particular, that this task is in the data structure as a subhtread) and switches to the executor thread.

The caller must arrange that the task gets woken.

With SetAwake, sets our task awake, so that we’ll be polled again as soon as we get to the top of the executor’s queue. Otherwise, we’ll be reentered after someone wakes a Waker for the task.

fn thread_context_switch( &self, data: MutexGuard<'_, Data>, us: ThreadDescriptor, them: ThreadDescriptor, )

Switch from (sub)thread us to (sub)thread them

Returns when someone calls thread_context_switch(.., us).

fn thread_context_switch_send_instruction_to_run( &self, data: &mut MutexGuard<'_, Data>, us: ThreadDescriptor, them: ThreadDescriptor, )

Instruct the (sub)thread them to run

Update thread_to_run, which will wake up them’s call to thread_context_switch_waitfor_instruction_to_run.

Must be called from (sub)thread us. Part of thread_context_switch, not normally called directly.

fn thread_context_switch_waitfor_instruction_to_run( &self, data: MutexGuard<'_, Data>, us: ThreadDescriptor, )

Await an instruction for this thread, us, to run

Waits for thread_to_run to be us, waiting for thread_condvar as necessary.

Part of thread_context_switch, not normally called directly.

impl Shared

fn lock(&self) -> MutexGuard<'_, Data>

Lock and obtain the guard

Convenience method which panics on poison

Trait Implementations

impl Default for Shared

fn default() -> Shared

Returns the “default value” for a type.