SharedCell

Struct SharedCell 

Source
pub struct SharedCell<T> { /* private fields */ }
Available on crate feature std only.
Expand description

Atomic shared version of OnceLock - backed by an Arc<RwLock<Option<T>>>.

let value = SharedCell::<bool>::empty(); // or default()
assert_eq!(None, value.take());

value.set(true);
assert_eq!(Some(true), value.take());
assert_eq!(None, value.take());

Implementations§

Source§

impl<T> SharedCell<T>

Source

pub fn empty() -> Self

Creates a new, unset cell.

Source

pub fn new(val: T) -> Self

Create a new, set cell with the provided value.

Source

pub fn set(&self, val: T)

Sets the value, throwing away any old value

Source

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

Takes the value, if previously set.

Source

pub fn peek<V: Fn(Option<&T>)>(&self, func: V)

Peeks at the value, does not consume it.

Source

pub fn as_ref(&self) -> ReadGuard<'_, T>

Returns a shared (locked) reference to the inner object

Source

pub fn peek_mut<V: FnMut(Option<&mut T>)>(&self, func: V)

Mutably peeks at the value, allows for edits.

Source

pub fn as_mut(&self) -> WriteGuard<'_, T>

Returns a mutable (locked) reference to the inner object.

Trait Implementations§

Source§

impl<T> Clone for SharedCell<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for SharedCell<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Default for SharedCell<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<T> From<Option<T>> for SharedCell<T>

Source§

fn from(value: Option<T>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<T> Freeze for SharedCell<T>

§

impl<T> RefUnwindSafe for SharedCell<T>

§

impl<T> Send for SharedCell<T>
where T: Send + Sync,

§

impl<T> Sync for SharedCell<T>
where T: Send + Sync,

§

impl<T> Unpin for SharedCell<T>

§

impl<T> UnwindSafe for SharedCell<T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> MaybeInto<U> for T
where U: MaybeFrom<T>,

Source§

fn maybe_into(self) -> Option<U>

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.