Struct SyncCell

pub struct SyncCell<T: ?Sized> { /* private fields */ }

A mutable memory location that can be modified safely from multiple threads. This structure is similar to std::cell::Cell or std::cell::RefCell while being thread-safe. It functions as a thin wrapper around std::sync::RwLock while assuming that poisoned locks indicate an unrecoverable error. This makes it more ergonomic to use than RwLock at the cost of some stability.

As a Cell replacement.

SyncCell can be used to replace the functionality of a std::cell::Cell in contexts where data need to mutably accessed across multiple threads.

Using std::cell::Cell

use std::cell::Cell;

let cell = Cell::new(0);

cell.set(1);

println!("{}", cell.get());

Using sync_cell::SyncCell

use sync_cell::SyncCell;

let cell = SyncCell::new(0);

cell.set(1);

println!("{}", cell.get());

As a RefCell replacement.

SyncCell can also be used to replace usages of RefCell.

Using std::cell::RefCell

use std::cell::RefCell;

let cell = RefCell::new((0, 1));

let borrowed = cell.borrow();
println!("{}", borrowed.0);
drop(borrowed);

let mut mutable_borrow = cell.borrow_mut();
mutable_borrow.1 = 2;
drop(mutable_borrow);

let borrowed = cell.borrow();
println!("{:?}", borrowed);

Using sync_cell::SyncCell

use sync_cell::SyncCell;

let cell = SyncCell::new((0, 1));

let borrowed = cell.borrow();
println!("{}", borrowed.0);
drop(borrowed);

let mut mutable_borrow = cell.borrow_mut();
mutable_borrow.1 = 2;
drop(mutable_borrow);

let borrowed = cell.borrow();
println!("{:?}", borrowed);

Panicking

Unlike std::sync::RwLock, SyncCell will panic rather than return an error when the lock becomes poisoned.

Implementations

impl<T> SyncCell<T>

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

Creates a new SyncCell.

• data - The initial value of the SyncCell.

pub fn set(&self, value: T)

Sets the value contained in this cell.

• value - The new value of the cell.

Panicking

This method will panic if the lock becomes poisoned.

pub fn into_inner(self) -> T

Retrieves the inner value stored in this SyncCell.

Panicking

This method will panic if the lock becomes poisoned.

pub fn replace(&self, value: T) -> T

Replaces the internal value contained in this cell. The previous value is returned.

• value - The new value of the cell.

Panicking

This method will panic if the lock becomes poisoned.

impl<T: ?Sized> SyncCell<T>

pub fn borrow(&self) -> RwLockReadGuard<'_, T>

Borrows a immutable reference to the data stored in this cell.

Panicking

This method will panic if the lock becomes poisoned.

pub fn borrow_mut(&self) -> RwLockWriteGuard<'_, T>

Borrows a mutable reference to the data stored in this cell.

Panicking

This method will panic if the lock becomes poisoned.

impl<T: Clone> SyncCell<T>

pub fn get(&self) -> T

Gets the value contained in this cell.

Panicking

This method will panic if the lock becomes poisoned.

Trait Implementations

impl<T: Clone> Clone for SyncCell<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ?Sized> Debug for SyncCell<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for SyncCell<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> From<T> for SyncCell<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: Hash + ?Sized> Hash for SyncCell<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord + ?Sized> Ord for SyncCell<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq + ?Sized> PartialEq for SyncCell<T>

fn eq(&self, other: &Self) -> 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<T: PartialOrd + ?Sized> PartialOrd for SyncCell<T>

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T: Eq + ?Sized> Eq for SyncCell<T>