Struct bones_framework::lib::prelude::AtomicCell
pub struct AtomicCell<T>where
T: ?Sized,{ /* private fields */ }
Expand description
A mutable memory location with dynamically checked borrow rules
This type behaves mostly like core::cell::RefCell
.
The main difference is that this type uses atomic operations for borrowing.
Thus allowing to use it in multi-threaded environment.
AtomicCell<T>
implements Send
if T: Send
.
AtomicCell<T>
implements Sync
if T: Send + Sync
.
Implementations§
§impl<T> AtomicCell<T>
impl<T> AtomicCell<T>
pub const fn new(value: T) -> AtomicCell<T>
pub const fn new(value: T) -> AtomicCell<T>
Creates a new AtomicCell
containing value.
§Examples
use atomicell::AtomicCell;
let cell = AtomicCell::new(5);
pub fn into_inner(self) -> T
pub fn into_inner(self) -> T
Consumes the AtomicCell
, returning the wrapped value.
§Examples
use atomicell::AtomicCell;
let c = AtomicCell::new(5);
let five = c.into_inner();
pub fn replace(&self, t: T) -> T
pub fn replace(&self, t: T) -> T
Replaces the wrapped value with a new one, returning the old value, without deinitializing either one.
This function corresponds to core::mem::replace.
§Panics
Panics if the value is currently borrowed.
§Examples
use atomicell::AtomicCell;
let cell = AtomicCell::new(5);
let old_value = cell.replace(6);
assert_eq!(old_value, 5);
assert_eq!(cell, AtomicCell::new(6));
pub fn replace_with<F>(&self, f: F) -> T
pub fn replace_with<F>(&self, f: F) -> T
Replaces the wrapped value with a new one computed from f, returning the old value, without deinitializing either one.
§Panics
Panics if the value is currently borrowed.
§Examples
use atomicell::AtomicCell;
let cell = AtomicCell::new(5);
let old_value = cell.replace_with(|&mut old| old + 1);
assert_eq!(old_value, 5);
assert_eq!(cell, AtomicCell::new(6));
pub fn swap(&self, other: &AtomicCell<T>)
pub fn swap(&self, other: &AtomicCell<T>)
Swaps the wrapped value of self with the wrapped value of other, without deinitializing either one.
This function corresponds to core::mem::swap.
§Panics
Panics if the value in either AtomicCell is currently borrowed.
§Examples
use atomicell::AtomicCell;
let c = AtomicCell::new(5);
let d = AtomicCell::new(6);
c.swap(&d);
assert_eq!(c, AtomicCell::new(6));
assert_eq!(d, AtomicCell::new(5));
§impl<T> AtomicCell<T>where
T: ?Sized,
impl<T> AtomicCell<T>where
T: ?Sized,
pub fn try_borrow(&self) -> Option<Ref<'_, T>>
pub fn try_borrow(&self) -> Option<Ref<'_, T>>
Immutably borrows the wrapped value,
returning None
if the value is currently mutably borrowed.
The borrow lasts until the returned Ref
, all Ref
s derived from it and all its clones exit scope.
Multiple immutable borrows can be taken out at the same time.
This is the non-panicking variant of borrow.
§Examples
use atomicell::AtomicCell;
let c = AtomicCell::new(5);
{
let m = c.borrow_mut();
assert!(c.try_borrow().is_none());
}
{
let m = c.borrow();
assert!(c.try_borrow().is_some());
}
pub fn borrow(&self) -> Ref<'_, T>
pub fn borrow(&self) -> Ref<'_, T>
Immutably borrows the wrapped value.
The borrow lasts until the returned Ref
, all Ref
s derived from it and all its clones exit scope.
Multiple immutable borrows can be taken out at the same time.
§Panics
Panics if the value is currently mutably borrowed. For a non-panicking variant, use try_borrow
.
§Examples
use atomicell::AtomicCell;
let c = AtomicCell::new(5);
let borrowed_five = c.borrow();
let borrowed_five2 = c.borrow();
An example of panic:
use atomicell::AtomicCell;
let c = AtomicCell::new(5);
let m = c.borrow_mut();
let b = c.borrow(); // this causes a panic
pub fn try_borrow_mut(&self) -> Option<RefMut<'_, T>>
pub fn try_borrow_mut(&self) -> Option<RefMut<'_, T>>
Mutably borrows the wrapped value, returning an error if the value is currently borrowed.
The borrow lasts until the returned RefMut
or all RefMut
s derived from it exit scope.
The value cannot be borrowed while this borrow is active.
This is the non-panicking variant of borrow_mut.
§Examples
use atomicell::AtomicCell;
let c = AtomicCell::new(5);
{
let m = c.borrow();
assert!(c.try_borrow_mut().is_none());
}
assert!(c.try_borrow_mut().is_some());
pub fn borrow_mut(&self) -> RefMut<'_, T>
pub fn borrow_mut(&self) -> RefMut<'_, T>
Mutably borrows the wrapped value.
The borrow lasts until the returned RefMut
or all RefMut
s derived from it exit scope.
The value cannot be borrowed while this borrow is active.
§Panics
Panics if the value is currently borrowed. For a non-panicking variant, use try_borrow_mut.
§Examples
use atomicell::AtomicCell;
let c = AtomicCell::new("hello".to_owned());
*c.borrow_mut() = "bonjour".to_owned();
assert_eq!(&*c.borrow(), "bonjour");
An example of panic:
use atomicell::AtomicCell;
let c = AtomicCell::new(5);
let m = c.borrow();
let b = c.borrow_mut(); // this causes a panic
pub const fn as_ptr(&self) -> *mut T
pub const fn as_ptr(&self) -> *mut T
Returns a raw pointer to the underlying data in this cell.
§Examples
use atomicell::AtomicCell;
let c = AtomicCell::new(5);
let ptr = c.as_ptr();
pub fn get_mut(&mut self) -> &mut T
pub fn get_mut(&mut self) -> &mut T
Returns a mutable reference to the underlying data.
This call borrows AtomicCell
mutably (at compile-time) so there is no need for dynamic checks.
However be cautious: this method expects self to be mutable,
which is generally not the case when using a AtomicCell
.
Take a look at the borrow_mut method instead if self isn’t mutable.
Also, please be aware that this method is only for special circumstances and is usually not what you want. In case of doubt, use borrow_mut instead.
§Examples
use atomicell::AtomicCell;
let mut c = AtomicCell::new(5);
*c.get_mut() += 1;
assert_eq!(c, AtomicCell::new(6));
pub fn undo_leak(&mut self) -> &mut T
pub fn undo_leak(&mut self) -> &mut T
Undo the effect of leaked guards on the borrow state of the AtomicCell
.
This call is similar to get_mut but more specialized.
It borrows AtomicCell
mutably to ensure no borrows exist and then resets the state tracking shared borrows.
This is relevant if some Ref or RefMut borrows have been leaked.
§Examples
use atomicell::AtomicCell;
let mut c = AtomicCell::new(0);
core::mem::forget(c.borrow_mut());
assert!(c.try_borrow().is_none());
c.undo_leak();
assert!(c.try_borrow().is_some());
pub unsafe fn try_borrow_unguarded(&self) -> Option<&T>
pub unsafe fn try_borrow_unguarded(&self) -> Option<&T>
Immutably borrows the wrapped value, returning None
if the value is currently mutably borrowed.
§Safety
Unlike borrow, this method is unsafe because it does not return a Ref
,
thus leaving the borrow flag untouched.
Mutably borrowing the AtomicCell
while the reference returned by this method is alive is undefined behaviour.
§Examples
use atomicell::AtomicCell;
let c = AtomicCell::new(5);
{
assert!(unsafe { c.try_borrow_unguarded() }.is_some());
let m = c.borrow_mut();
assert!(unsafe { c.try_borrow_unguarded() }.is_none());
}
{
let m = c.borrow();
assert!(unsafe { c.try_borrow_unguarded() }.is_some());
}
pub unsafe fn try_borrow_unguarded_mut(&self) -> Option<&mut T>
pub unsafe fn try_borrow_unguarded_mut(&self) -> Option<&mut T>
Mutably borrows the wrapped value, returning None
if the value is currently mutably borrowed.
§Safety
Unlike borrow_mut, this method is unsafe because it does not return a Ref
,
and leaves the borrow flag untouched.
Borrowing the AtomicCell
while the reference returned by this method is alive is undefined behaviour.
§Examples
use atomicell::AtomicCell;
let c = AtomicCell::new(5);
{
assert!(unsafe { c.try_borrow_unguarded_mut() }.is_some());
let m = c.borrow();
assert!(unsafe { c.try_borrow_unguarded_mut() }.is_none());
}
§impl<T> AtomicCell<T>where
T: Default,
impl<T> AtomicCell<T>where
T: Default,
pub fn take(&self) -> T
pub fn take(&self) -> T
Takes the wrapped value, leaving Default::default()
in its place.
§Panics
Panics if the value is currently borrowed.
§Examples
use atomicell::AtomicCell;
let c = AtomicCell::new(5);
let five = c.take();
assert_eq!(five, 5);
assert_eq!(c.into_inner(), 0);
Trait Implementations§
§impl<T> Clone for AtomicCell<T>where
T: Clone,
impl<T> Clone for AtomicCell<T>where
T: Clone,
§fn clone(&self) -> AtomicCell<T>
fn clone(&self) -> AtomicCell<T>
§fn clone_from(&mut self, other: &AtomicCell<T>)
fn clone_from(&mut self, other: &AtomicCell<T>)
source
. Read more§impl<T> Debug for AtomicCell<T>where
T: Debug,
impl<T> Debug for AtomicCell<T>where
T: Debug,
§impl<T> Display for AtomicCell<T>where
T: Display,
impl<T> Display for AtomicCell<T>where
T: Display,
§impl<T> From<T> for AtomicCell<T>
impl<T> From<T> for AtomicCell<T>
§fn from(t: T) -> AtomicCell<T>
fn from(t: T) -> AtomicCell<T>
§impl<T> Ord for AtomicCell<T>where
T: Ord,
impl<T> Ord for AtomicCell<T>where
T: Ord,
§impl<T, U> PartialEq<AtomicCell<U>> for AtomicCell<T>where
T: PartialEq<U>,
impl<T, U> PartialEq<AtomicCell<U>> for AtomicCell<T>where
T: PartialEq<U>,
§fn eq(&self, other: &AtomicCell<U>) -> bool
fn eq(&self, other: &AtomicCell<U>) -> bool
self
and other
values to be equal, and is used
by ==
.§impl<T, U> PartialOrd<AtomicCell<U>> for AtomicCell<T>where
T: PartialOrd<U>,
impl<T, U> PartialOrd<AtomicCell<U>> for AtomicCell<T>where
T: PartialOrd<U>,
§fn partial_cmp(&self, other: &AtomicCell<U>) -> Option<Ordering>
fn partial_cmp(&self, other: &AtomicCell<U>) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moreimpl<T> Eq for AtomicCell<T>where
T: Eq,
impl<T> Send for AtomicCell<T>where
T: Send,
AtomicCell
can be sent to another thread if value can be sent.
Sending can occur on owned cell or mutable reference to it.
Either way it is not borrowed, so it is impossible to share stored value this way.
impl<T> Sync for AtomicCell<T>
AtomicCell
can be shared across threads if value can be sent and shared.
Requires T: Send
because mutable borrow can occur in another thread.
Requires T: Sync
because immutable borrows could occur concurrently in different threads.
Auto Trait Implementations§
impl<T> !Freeze for AtomicCell<T>
impl<T> !RefUnwindSafe for AtomicCell<T>
impl<T> Unpin for AtomicCell<T>
impl<T> UnwindSafe for AtomicCell<T>where
T: UnwindSafe + ?Sized,
Blanket Implementations§
§impl<T> AnyEq for T
impl<T> AnyEq for T
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
§impl<T> Conv for T
impl<T> Conv for T
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
fn into_sample(self) -> T
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.