Struct HeldSyncCell

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

A cell that holds a value until any changes made are applied by use of the update method. Getting the value or obtaining a reference to the value in this cell will return the value immediately following the last call to update. This allows for mutably altering a value while keeping a reference for a short amount of time to the old value. This is useful when you want a method in a structure to be able to modify the structure it is being called from such as when changing the scene in a game engine.

Usage

use sync_cell::HeldSyncCell;

let cell = HeldSyncCell::new(0);

// Set the next value of the cell.
cell.set(1);

// Cell continues to hold a value of 0 until the `update` method is called.
assert_eq!(0, cell.get());

cell.update();
assert_eq!(1, cell.get());

Implementations

impl<T> HeldSyncCell<T>

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

Creates a new HeldSyncCell.

• data - The initial value of the HeldSyncCell.

pub fn set(&self, value: T)

Sets the value contained in this cell. This value will only become available once the update method is called.

In the case that multiple threads call this method simultaniously, the order in which the calls are processed is not defined. However, the final result will be the value specified by one of the method calls.

• value - The new value of the cell.

Panicking

This method will panic if any of the locks become poisoned.

pub fn into_inner(self) -> T

Retrieves the inner value stored in this HeldSyncCell. This will return the most up-to-date value even if update has not been called.

Panicking

This method will panic if any of the locks become poisoned.

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

Borrows a immutable reference to the data stored in this cell. This is a reference to the current value of the cell.

Panicking

This method will panic if any of the locks become poisoned.

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

Borrows a mutable reference to the data stored in this cell. This is a reference to the current value of the cell not the incoming value. Any changes to the value will update the current value.

Panicking

This method will panic if any of the locks become poisoned.

pub fn has_update(&self) -> bool

Checks if a new nalue is available that can be applied by calling update.

Panicking

This method will panic if any of the locks become poisoned.

pub fn update(&self)

Updates the internal value of this cell. This involves replacing the current value with the incoming value if it is available.

Panicking

This method will panic if any of the locks become poisoned.

impl<T: Clone> HeldSyncCell<T>

pub fn get(&self) -> T

Gets the value contained in this cell.

Panicking

This method will panic if any of the locks become poisoned.

Trait Implementations

impl<T: Clone> Clone for HeldSyncCell<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Default> Default for HeldSyncCell<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> From<T> for HeldSyncCell<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for HeldSyncCell<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> Ord for HeldSyncCell<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> PartialEq for HeldSyncCell<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> PartialOrd for HeldSyncCell<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> Eq for HeldSyncCell<T>