Struct enso_flexer::prelude::logger::prelude::Cell 1.0.0[−][src]
#[repr(transparent)]pub struct Cell<T> where
T: ?Sized, { /* fields omitted */ }
Expand description
A mutable memory location.
Examples
In this example, you can see that Cell<T>
enables mutation inside an
immutable struct. In other words, it enables “interior mutability”.
use std::cell::Cell; struct SomeStruct { regular_field: u8, special_field: Cell<u8>, } let my_struct = SomeStruct { regular_field: 0, special_field: Cell::new(1), }; let new_value = 100; // ERROR: `my_struct` is immutable // my_struct.regular_field = new_value; // WORKS: although `my_struct` is immutable, `special_field` is a `Cell`, // which can always be mutated my_struct.special_field.set(new_value); assert_eq!(my_struct.special_field.get(), new_value);
See the module-level documentation for more.
Implementations
impl<T> Cell<T>
[src]
impl<T> Cell<T>
[src]pub fn swap(&self, other: &Cell<T>)
1.17.0[src]
pub fn swap(&self, other: &Cell<T>)
1.17.0[src]Swaps the values of two Cells.
Difference with std::mem::swap
is that this function doesn’t require &mut
reference.
Examples
use std::cell::Cell; let c1 = Cell::new(5i32); let c2 = Cell::new(10i32); c1.swap(&c2); assert_eq!(10, c1.get()); assert_eq!(5, c2.get());
pub fn replace(&self, val: T) -> T
1.17.0[src]
pub fn replace(&self, val: T) -> T
1.17.0[src]Replaces the contained value with val
, and returns the old contained value.
Examples
use std::cell::Cell; let cell = Cell::new(5); assert_eq!(cell.get(), 5); assert_eq!(cell.replace(10), 5); assert_eq!(cell.get(), 10);
pub const fn into_inner(self) -> T
1.17.0[src]
pub const fn into_inner(self) -> T
1.17.0[src]Unwraps the value.
Examples
use std::cell::Cell; let c = Cell::new(5); let five = c.into_inner(); assert_eq!(five, 5);
impl<T> Cell<T> where
T: Copy,
[src]
impl<T> Cell<T> where
T: Copy,
[src]pub fn get(&self) -> T
[src]
pub fn get(&self) -> T
[src]Returns a copy of the contained value.
Examples
use std::cell::Cell; let c = Cell::new(5); let five = c.get();
pub fn update<F>(&self, f: F) -> T where
F: FnOnce(T) -> T,
[src]
🔬 This is a nightly-only experimental API. (cell_update
)
pub fn update<F>(&self, f: F) -> T where
F: FnOnce(T) -> T,
[src]cell_update
)Updates the contained value using a function and returns the new value.
Examples
#![feature(cell_update)] use std::cell::Cell; let c = Cell::new(5); let new = c.update(|x| x + 1); assert_eq!(new, 6); assert_eq!(c.get(), 6);
impl<T> Cell<T> where
T: ?Sized,
[src]
impl<T> Cell<T> where
T: ?Sized,
[src]pub const fn as_ptr(&self) -> *mut T
1.12.0 (const: 1.32.0)[src]
pub const fn as_ptr(&self) -> *mut T
1.12.0 (const: 1.32.0)[src]Returns a raw pointer to the underlying data in this cell.
Examples
use std::cell::Cell; let c = Cell::new(5); let ptr = c.as_ptr();
pub fn get_mut(&mut self) -> &mut T
1.11.0[src]
pub fn get_mut(&mut self) -> &mut T
1.11.0[src]Returns a mutable reference to the underlying data.
This call borrows Cell
mutably (at compile-time) which guarantees
that we possess the only reference.
Examples
use std::cell::Cell; let mut c = Cell::new(5); *c.get_mut() += 1; assert_eq!(c.get(), 6);
pub fn from_mut(t: &mut T) -> &Cell<T>
1.37.0[src]
pub fn from_mut(t: &mut T) -> &Cell<T>
1.37.0[src]Returns a &Cell<T>
from a &mut T
Examples
use std::cell::Cell; let slice: &mut [i32] = &mut [1, 2, 3]; let cell_slice: &Cell<[i32]> = Cell::from_mut(slice); let slice_cell: &[Cell<i32>] = cell_slice.as_slice_of_cells(); assert_eq!(slice_cell.len(), 3);
impl<T> Cell<[T]>
[src]
impl<T> Cell<[T]>
[src]pub fn as_slice_of_cells(&self) -> &[Cell<T>]ⓘ
1.37.0[src]
pub fn as_slice_of_cells(&self) -> &[Cell<T>]ⓘ
1.37.0[src]Returns a &[Cell<T>]
from a &Cell<[T]>
Examples
use std::cell::Cell; let slice: &mut [i32] = &mut [1, 2, 3]; let cell_slice: &Cell<[i32]> = Cell::from_mut(slice); let slice_cell: &[Cell<i32>] = cell_slice.as_slice_of_cells(); assert_eq!(slice_cell.len(), 3);
Trait Implementations
impl<T> AbsDiffEq<Cell<T>> for Cell<T> where
T: AbsDiffEq<T> + Copy,
impl<T> AbsDiffEq<Cell<T>> for Cell<T> where
T: AbsDiffEq<T> + Copy,
type Epsilon = <T as AbsDiffEq<T>>::Epsilon
type Epsilon = <T as AbsDiffEq<T>>::Epsilon
Used for specifying relative comparisons.
pub fn default_epsilon() -> <T as AbsDiffEq<T>>::Epsilon
pub fn default_epsilon() -> <T as AbsDiffEq<T>>::Epsilon
The default tolerance to use when testing values that are close together. Read more
pub fn abs_diff_eq(
&self,
other: &Cell<T>,
epsilon: <T as AbsDiffEq<T>>::Epsilon
) -> bool
pub fn abs_diff_eq(
&self,
other: &Cell<T>,
epsilon: <T as AbsDiffEq<T>>::Epsilon
) -> bool
A test for equality that uses the absolute difference to compute the approximate equality of two numbers. Read more
fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool
fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool
The inverse of ApproxEq::abs_diff_eq
.
impl<T> CellGetter for Cell<T> where
T: Copy,
[src]
impl<T> CellGetter for Cell<T> where
T: Copy,
[src]impl<T> CellSetter for Cell<T> where
T: Copy,
[src]
impl<T> CellSetter for Cell<T> where
T: Copy,
[src]impl<T> Ord for Cell<T> where
T: Ord + Copy,
1.10.0[src]
impl<T> Ord for Cell<T> where
T: Ord + Copy,
1.10.0[src]impl<T> PartialOrd<Cell<T>> for Cell<T> where
T: PartialOrd<T> + Copy,
1.10.0[src]
impl<T> PartialOrd<Cell<T>> for Cell<T> where
T: PartialOrd<T> + Copy,
1.10.0[src]pub fn partial_cmp(&self, other: &Cell<T>) -> Option<Ordering>
[src]
pub fn partial_cmp(&self, other: &Cell<T>) -> Option<Ordering>
[src]This method returns an ordering between self
and other
values if one exists. Read more
pub fn lt(&self, other: &Cell<T>) -> bool
[src]
pub fn lt(&self, other: &Cell<T>) -> bool
[src]This method tests less than (for self
and other
) and is used by the <
operator. Read more
pub fn le(&self, other: &Cell<T>) -> bool
[src]
pub fn le(&self, other: &Cell<T>) -> bool
[src]This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl<T> RelativeEq<Cell<T>> for Cell<T> where
T: RelativeEq<T> + Copy,
impl<T> RelativeEq<Cell<T>> for Cell<T> where
T: RelativeEq<T> + Copy,
pub fn default_max_relative() -> <T as AbsDiffEq<T>>::Epsilon
pub fn default_max_relative() -> <T as AbsDiffEq<T>>::Epsilon
The default relative tolerance for testing values that are far-apart. Read more
pub fn relative_eq(
&self,
other: &Cell<T>,
epsilon: <T as AbsDiffEq<T>>::Epsilon,
max_relative: <T as AbsDiffEq<T>>::Epsilon
) -> bool
pub fn relative_eq(
&self,
other: &Cell<T>,
epsilon: <T as AbsDiffEq<T>>::Epsilon,
max_relative: <T as AbsDiffEq<T>>::Epsilon
) -> bool
A test for equality that uses a relative comparison if the values are far apart.
fn relative_ne(
&self,
other: &Rhs,
epsilon: Self::Epsilon,
max_relative: Self::Epsilon
) -> bool
fn relative_ne(
&self,
other: &Rhs,
epsilon: Self::Epsilon,
max_relative: Self::Epsilon
) -> bool
The inverse of ApproxEq::relative_eq
.
impl<T> UlpsEq<Cell<T>> for Cell<T> where
T: UlpsEq<T> + Copy,
impl<T> UlpsEq<Cell<T>> for Cell<T> where
T: UlpsEq<T> + Copy,
pub fn default_max_ulps() -> u32
pub fn default_max_ulps() -> u32
The default ULPs to tolerate when testing values that are far-apart. Read more
impl<T, U> CoerceUnsized<Cell<U>> for Cell<T> where
T: CoerceUnsized<U>,
[src]
T: CoerceUnsized<U>,
impl<T> Eq for Cell<T> where
T: Eq + Copy,
1.2.0[src]
T: Eq + Copy,
impl<T> Send for Cell<T> where
T: Send + ?Sized,
[src]
T: Send + ?Sized,
impl<T> !Sync for Cell<T> where
T: ?Sized,
[src]
T: ?Sized,
Auto Trait Implementations
impl<T> !RefUnwindSafe for Cell<T>
impl<T: ?Sized> Unpin for Cell<T> where
T: Unpin,
T: Unpin,
impl<T: ?Sized> UnwindSafe for Cell<T> where
T: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> CellProperty for T where
T: CellGetter + CellSetter + ItemClone,
[src]
impl<T> CellProperty for T where
T: CellGetter + CellSetter + ItemClone,
[src]impl<T> HasRefValue for T where
T: ?Sized,
[src]
impl<T> HasRefValue for T where
T: ?Sized,
[src]type RefValue = T
impl<T> PhantomConversions for T
[src]
impl<T> PhantomConversions for T
[src]fn phantom_into<P>() -> P where
Self: PhantomInto<P>,
[src]
Self: PhantomInto<P>,
fn phantom_from<P>() -> Self where
P: PhantomInto<Self>,
[src]
P: PhantomInto<Self>,
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
pub fn to_subset(&self) -> Option<SS>
pub fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> TypeDisplay for T
[src]
impl<T> TypeDisplay for T
[src]pub default fn type_display() -> String
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
impl<T> Writer for T
[src]
impl<T> Writer for T
[src]pub default fn write_by_level(&self, message: &Array)
[src]
pub default fn write_by_level(&self, message: &Array)
[src]Write message using the appropriate console method.