Struct TaskLocal 

pub struct TaskLocal<T> {
    inner: UnsafeCell<T>,
}

A cell type for task-local data that is only accessed by the hart currently executing the task.

Safety

This type uses UnsafeCell internally and is Sync so it can live inside Task (which is Send + Sync). The safety invariant is:

• Only the hart that is currently running this task may access the contents. Because a task is scheduled on exactly one hart at a time, there is no concurrent access and no lock is needed.
• During clone_task, the parent accesses its own TaskLocal fields (safe – it is the running hart) and writes to the child’s TaskLocal fields (safe – the child has not been added to the scheduler yet, so no other hart can touch it).

Fields

inner: UnsafeCell<T>

Implementations

impl<T> TaskLocal<T>

pub fn new(value: T) -> Self

Create a new TaskLocal with the given value.

pub unsafe fn get(&self) -> &T

Get an immutable reference to the contained value.

Safety

The caller must be the hart currently executing the owning task, or the task must not yet be visible to the scheduler.

pub unsafe fn get_mut(&self) -> &mut T

Get a mutable reference to the contained value.

Safety

The caller must be the hart currently executing the owning task, or the task must not yet be visible to the scheduler.

Trait Implementations

impl<T> Sync for TaskLocal<T>