Struct threadcell::ThreadCell

pub struct ThreadCell<T> { /* private fields */ }

A cell that can be owned by a single thread or none at all.

Implementations

impl<T> ThreadCell<T>

pub const fn new_disowned(data: T) -> Self

Creates a ThreadCell that is not owned by any thread. This is a const fn which allows static construction of ThreadCells.

pub fn new_owned(data: T) -> Self

Creates a ThreadCell that is owned by the current thread.

pub fn acquire(&self)

Takes the ownership of a cell. This is a no-op when the cell is already owned by the current thread.

Panics

When the cell is owned by another thread.

pub fn try_acquire(&self) -> bool

Tries to take the ownership of a cell. Returns true when the ownership could be obtained or the cell was already owned by the current thread and false when the cell is owned by another thread.

pub fn acquire_get(&self) -> &T

Takes the ownership of a cell and returns a reference to its value.

Panics

When the cell is owned by another thread.

pub fn try_acquire_get(&self) -> Option<&T>

Tries to take the ownership of a cell and returns a reference to its value. Will return ‘None’ when the cell is owned by another thread.

pub fn acquire_get_mut(&mut self) -> &mut T

Takes the ownership of a cell and returns a mutable reference to its value.

Panics

When the cell is owned by another thread.

pub fn try_acquire_get_mut(&mut self) -> Option<&mut T>

Tries to take the ownership of a cell and returns a mutable reference to its value. Will return ‘None’ when the cell is owned by another thread.

pub unsafe fn steal(&self)

Takes the ownership of a cell unconditionally. This is a no-op when the cell is already owned by the current thread.

Safety

This method does not check if the cell is owned by another thread. The owning thread may operate on the content, thus a data race/UB will happen when the accessed value is not Sync. The previous owning thread may panic when it expects owning the cell. The only safe way to use this method is to recover a cell that is owned by a thread that finished without releasing it (e.g after a panic).

pub fn release(&self)

Sets a ThreadCell which is owned by the current thread into the disowned state.

Panics

The current thread does not own the cell.

pub fn try_release(&self) -> bool

Tries to set a ThreadCell which is owned by the current thread into the disowned state. Returns true on success and false when the current thread does not own the cell.

pub fn is_owned(&self) -> bool

Returns true when the current thread owns this cell.

pub fn into_inner(self) -> T

Consumes a owned cell and returns its content.

Panics

The current thread does not own the cell.

pub fn get(&self) -> &T

Gets an immutable reference to the cells content.

Panics

The current thread does not own the cell.

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

Gets a mutable reference to the cells content.

Panics

The current thread does not own the cell.

pub fn try_get(&self) -> Option<&T>

Tries to get an immutable reference to the cells content. Returns ‘None’ when the thread does not own the cell.

pub fn try_get_mut(&mut self) -> Option<&mut T>

Tries to get a mutable reference to the cells content. Returns ‘None’ when the thread does not own the cell.

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

Gets an immutable reference to the cells content without checking for ownership.

Safety

This is always safe when the thread owns the cell, for example right after a get_ownership() call. When the current thread does not own the cell then it is only safe when T is a Sync type.

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

Gets an mutable reference to the cells content without checking for ownership.

Safety

This is always safe when the thread owns the cell, for example right after a get_ownership() call. When the current thread does not own the cell then it is only safe when T is a Sync type.

Trait Implementations

impl<T: Clone> Clone for ThreadCell<T>

Clones a owned ThreadCell.

Panics

Another thread owns the cell.

fn clone(&self) -> ThreadCell<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ThreadCell<T>

Debug information of a ThreadCell. Prints “<invalid thread>” when the current thread does not own the cell.

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

Formats the value using the given formatter.

impl<T: Default> Default for ThreadCell<T>

Creates a new owned ThreadCell with the default constructed target value.

fn default() -> ThreadCell<T>

Returns the “default value” for a type.

impl<T: Display> Display for ThreadCell<T>

Formatted output of the value inside a ThreadCell.

Panics

The cell is not owned by the current thread.

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

Formats the value using the given formatter.

impl<T> Drop for ThreadCell<T>

Destroys a ThreadCell. The cell must be either owned by the current thread or disowned.

Panics

Another thread owns the cell.

fn drop(&mut self)

Executes the destructor for this type.

impl<T> From<T> for ThreadCell<T>

Creates a new owned ThreadCell from the given value.

fn from(t: T) -> ThreadCell<T>

Converts to this type from the input type.

impl<T: Ord> Ord for ThreadCell<T>

Compare two ThreadCells.

Panics

Either cell is not owned by the current thread.

fn cmp(&self, other: &ThreadCell<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self where
    Self: PartialOrd<Self>, 

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<ThreadCell<T>> for ThreadCell<T>

Check two ThreadCells for partial equality.

Panics

Either cell is not owned by the current thread.

fn eq(&self, other: &ThreadCell<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T: PartialOrd> PartialOrd<ThreadCell<T>> for ThreadCell<T>

Comparison functions between ThreadCells.

Panics

Either cell is not owned by the current thread.

fn partial_cmp(&self, other: &ThreadCell<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &ThreadCell<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &ThreadCell<T>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &ThreadCell<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &ThreadCell<T>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Eq> Eq for ThreadCell<T>

impl<T> Send for ThreadCell<T>

Safety

This type is meant for sending values that are !Send to other threads.

impl<T> Sync for ThreadCell<T>

Safety

Only the owning thread can access the value or release ownership. The ThreadCell itself can be shared between threads (for acquiring ownership etc). Ownership handling done by atomic primitives.