Struct st8b7c:f320:99b9:690f:4595:cd17:293a:c069cell8b7c:f320:99b9:690f:4595:cd17:293a:c069ll
#[repr(transparent)]pub struct Cell<T>where    T: ?Sized,{ /* private fields */ }
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 st8b7c:f320:99b9:690f:4595:cd17:293a:c069cell8b7c:f320:99b9:690f:4595:cd17:293a:c069ll;

struct SomeStruct {
    regular_field: u8,
    special_field: Cell<u8>,
}

let my_struct = SomeStruct {
    regular_field: 0,
    special_field: Cell8b7c:f320:99b9:690f:4595:cd17:293a:c069new(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

sourceimpl<T> Cell<T>
sourceconst: 1.24.0 · pub const fn new(value: T) -> Cell<T>
Creates a new Cell containing the given value. Examples use st8b7c:f320:99b9:690f:4595:cd17:293a:c069cell8b7c:f320:99b9:690f:4595:cd17:293a:c069ll;

let c = Cell8b7c:f320:99b9:690f:4595:cd17:293a:c069new(5); 
sourcepub fn set(&self, val: T)
Sets the contained value. Examples use st8b7c:f320:99b9:690f:4595:cd17:293a:c069cell8b7c:f320:99b9:690f:4595:cd17:293a:c069ll;

let c = Cell8b7c:f320:99b9:690f:4595:cd17:293a:c069new(5);

c.set(10); 
source1.17.0 · pub fn swap(&self, other: &Cell<T>)
Swaps the values of two Cells. Difference with st8b7c:f320:99b9:690f:4595:cd17:293a:c069mem8b7c:f320:99b9:690f:4595:cd17:293a:c069swap is that this function doesn’t require &mut reference. Examples use st8b7c:f320:99b9:690f:4595:cd17:293a:c069cell8b7c:f320:99b9:690f:4595:cd17:293a:c069ll;

let c1 = Cell8b7c:f320:99b9:690f:4595:cd17:293a:c069new(5i32);
let c2 = Cell8b7c:f320:99b9:690f:4595:cd17:293a:c069new(10i32);
c1.swap(&c2);
assert_eq!(10, c1.get());
assert_eq!(5, c2.get()); 
source1.17.0 · pub fn replace(&self, val: T) -> T
Replaces the contained value with val, and returns the old contained value. Examples use st8b7c:f320:99b9:690f:4595:cd17:293a:c069cell8b7c:f320:99b9:690f:4595:cd17:293a:c069ll;

let cell = Cell8b7c:f320:99b9:690f:4595:cd17:293a:c069new(5);
assert_eq!(cell.get(), 5);
assert_eq!(cell.replace(10), 5);
assert_eq!(cell.get(), 10); 
source1.17.0 (const: unstable) · pub fn into_inner(self) -> T
Unwraps the value. Examples use st8b7c:f320:99b9:690f:4595:cd17:293a:c069cell8b7c:f320:99b9:690f:4595:cd17:293a:c069ll;

let c = Cell8b7c:f320:99b9:690f:4595:cd17:293a:c069new(5);
let five = c.into_inner();

assert_eq!(five, 5); 

sourceimpl<T> Cell<T>where T: Copy,

sourcepub fn get(&self) -> T
Returns a copy of the contained value. Examples use st8b7c:f320:99b9:690f:4595:cd17:293a:c069cell8b7c:f320:99b9:690f:4595:cd17:293a:c069ll;

let c = Cell8b7c:f320:99b9:690f:4595:cd17:293a:c069new(5);

let five = c.get(); 
sourcepub fn update<F>(&self, f: F) -> Twhere F: FnOnce(T) -> T,

🔬This is a nightly-only experimental API. (cell_update #50186)

Updates the contained value using a function and returns the new value. Examples #![feature(cell_update)]

use st8b7c:f320:99b9:690f:4595:cd17:293a:c069cell8b7c:f320:99b9:690f:4595:cd17:293a:c069ll;

let c = Cell8b7c:f320:99b9:690f:4595:cd17:293a:c069new(5);
let new = c.update(|x| x + 1);

assert_eq!(new, 6);
assert_eq!(c.get(), 6); 

sourceimpl<T> Cell<T>where T: ?Sized,

source1.12.0 (const: 1.32.0) · pub const fn as_ptr(&self) -> *mut T
Returns a raw pointer to the underlying data in this cell. Examples use st8b7c:f320:99b9:690f:4595:cd17:293a:c069cell8b7c:f320:99b9:690f:4595:cd17:293a:c069ll;

let c = Cell8b7c:f320:99b9:690f:4595:cd17:293a:c069new(5);

let ptr = c.as_ptr(); 
source1.11.0 · pub fn get_mut(&mut self) -> &mut T
Returns a mutable reference to the underlying data. This call borrows Cell mutably (at compile-time) which guarantees that we possess the only reference. However be cautious: this method expects self to be mutable, which is generally not the case when using a Cell. If you require interior mutability by reference, consider using RefCell which provides run-time checked mutable borrows through its borrow_mut method. Examples use st8b7c:f320:99b9:690f:4595:cd17:293a:c069cell8b7c:f320:99b9:690f:4595:cd17:293a:c069ll;

let mut c = Cell8b7c:f320:99b9:690f:4595:cd17:293a:c069new(5);
*c.get_mut() += 1;

assert_eq!(c.get(), 6); 
source1.37.0 · pub fn from_mut(t: &mut T) -> &Cell<T>
Returns a &Cell<T> from a &mut T Examples use st8b7c:f320:99b9:690f:4595:cd17:293a:c069cell8b7c:f320:99b9:690f:4595:cd17:293a:c069ll;

let slice: &mut [i32] = &mut [1, 2, 3];
let cell_slice: &Cell<[i32]> = Cell8b7c:f320:99b9:690f:4595:cd17:293a:c069rom_mut(slice);
let slice_cell: &[Cell<i32>] = cell_slice.as_slice_of_cells();

assert_eq!(slice_cell.len(), 3); 

sourceimpl<T> Cell<T>where T: Default,

source1.17.0 · pub fn take(&self) -> T
Takes the value of the cell, leaving Default8b7c:f320:99b9:690f:4595:cd17:293a:c069ult() in its place. Examples use st8b7c:f320:99b9:690f:4595:cd17:293a:c069cell8b7c:f320:99b9:690f:4595:cd17:293a:c069ll;

let c = Cell8b7c:f320:99b9:690f:4595:cd17:293a:c069new(5);
let five = c.take();

assert_eq!(five, 5);
assert_eq!(c.into_inner(), 0); 

sourceimpl<T> Cell<[T]>
source1.37.0 · pub fn as_slice_of_cells(&self) -> &[Cell<T>]
Returns a &[Cell<T>] from a &Cell<[T]> Examples use st8b7c:f320:99b9:690f:4595:cd17:293a:c069cell8b7c:f320:99b9:690f:4595:cd17:293a:c069ll;

let slice: &mut [i32] = &mut [1, 2, 3];
let cell_slice: &Cell<[i32]> = Cell8b7c:f320:99b9:690f:4595:cd17:293a:c069rom_mut(slice);
let slice_cell: &[Cell<i32>] = cell_slice.as_slice_of_cells();

assert_eq!(slice_cell.len(), 3); 

sourceimpl<T, const N: usize> Cell<[T; N]>
sourcepub fn as_array_of_cells(&self) -> &[Cell<T>; N]
🔬This is a nightly-only experimental API. (as_array_of_cells #88248)

Returns a &[Cell<T>; N] from a &Cell<[T; N]> Examples #![feature(as_array_of_cells)]
use st8b7c:f320:99b9:690f:4595:cd17:293a:c069cell8b7c:f320:99b9:690f:4595:cd17:293a:c069ll;

let mut array: [i32; 3] = [1, 2, 3];
let cell_array: &Cell<[i32; 3]> = Cell8b7c:f320:99b9:690f:4595:cd17:293a:c069rom_mut(&mut array);
let array_cell: &[Cell<i32>; 3] = cell_array.as_array_of_cells(); 


Trait Implementations

sourceimpl<T> Clone for Cell<T>where T: Copy,

sourcefn clone(&self) -> Cell<T>Returns a copy of the value. Read more

sourcefn clone_from(&mut self, source: &Self)Performs copy-assignment from source. Read more


sourceimpl<T> Debug for Cell<T>where T: Copy + Debug,

sourcefn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>Formats the value using the given formatter. Read more


sourceimpl<T> Default for Cell<T>where T: Default,

sourcefn default() -> Cell<T>
Creates a Cell<T>, with the Default value for T. 

source1.12.0 (const: unstable) · impl<T> From<T> for Cell<T>
sourceconst: unstable · fn from(t: T) -> Cell<T>
Creates a new Cell<T> containing the given value. 

source1.10.0 · impl<T> Ord for Cell<T>where T: Ord + Copy,

sourcefn cmp(&self, other: &Cell<T>) -> OrderingThis method returns an Ordering between self and other. Read more

source1.21.0 · fn max(self, other: Self) -> SelfCompares and returns the maximum of two values. Read more

source1.21.0 · fn min(self, other: Self) -> SelfCompares and returns the minimum of two values. Read more

source1.50.0 · fn clamp(self, min: Self, max: Self) -> Selfwhere Self: PartialOrd<Self>,
Restrict a value to a certain interval. Read more


sourceimpl<T> PartialEq<Cell<T>> for Cell<T>where T: PartialEq<T> + Copy,

sourcefn eq(&self, other: &Cell<T>) -> boolThis method tests for self and other values to be equal, and is used by ==. Read more

sourcefn ne(&self, other: &Rhs) -> boolThis method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more


source1.10.0 · impl<T> PartialOrd<Cell<T>> for Cell<T>where T: PartialOrd<T> + Copy,

sourcefn partial_cmp(&self, other: &Cell<T>) -> Option<Ordering>This method returns an ordering between self and other values if one exists. Read more

sourcefn lt(&self, other: &Cell<T>) -> boolThis method tests less than (for self and other) and is used by the < operator. Read more

sourcefn le(&self, other: &Cell<T>) -> boolThis method tests less than or equal to (for self and other) and is used by the <= operator. Read more

sourcefn gt(&self, other: &Cell<T>) -> boolThis method tests greater than (for self and other) and is used by the > operator. Read more

sourcefn ge(&self, other: &Cell<T>) -> boolThis method tests greater than or equal to (for self and other) and is used by the >= operator. Read more


sourceimpl<T, U> CoerceUnsized<Cell<U>> for Cell<T>where T: CoerceUnsized<U>,
source1.2.0 · impl<T> Eq for Cell<T>where T: Eq + Copy,
sourceimpl<T> Send for Cell<T>where T: Send + ?Sized,
sourceimpl<T> !Sync for Cell<T>where T: ?Sized,


Auto Trait Implementations

impl<T> !RefUnwindSafe for Cell<T>impl<T: ?Sized> Unpin for Cell<T>where T: Unpin,
impl<T: ?Sized> UnwindSafe for Cell<T>where T: UnwindSafe,


Blanket Implementations

sourceimpl<T> Any for Twhere T: 'static + ?Sized,

sourcefn type_id(&self) -> TypeIdGets the TypeId of self. Read more


sourceimpl<T> Borrow<T> for Twhere T: ?Sized,

sourceconst: unstable · fn borrow(&self) -> &TImmutably borrows from an owned value. Read more


sourceimpl<T> BorrowMut<T> for Twhere T: ?Sized,

sourceconst: unstable · fn borrow_mut(&mut self) -> &mut TMutably borrows from an owned value. Read more


sourceimpl<T> From<!> for T
sourceconst: unstable · fn from(t: !) -> TConverts to this type from the input type.

sourceimpl<T> From<T> for T
sourceconst: unstable · fn from(t: T) -> T
Returns the argument unchanged. 

sourceimpl<T, U> Into<U> for Twhere U: From<T>,

sourceconst: unstable · fn into(self) -> U
Calls U8b7c:f320:99b9:690f:4595:cd17:293a:c069rom(self). That is, this conversion is whatever the implementation of From<T> for U chooses to do. 

sourceimpl<T> ToOwned for Twhere T: Clone,

type Owned = TThe resulting type after obtaining ownership.
sourcefn to_owned(&self) -> TCreates owned data from borrowed data, usually by cloning. Read more

sourcefn clone_into(&self, target: &mut T)Uses borrowed data to replace owned data, usually by cloning. Read more


sourceimpl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = InfallibleThe type returned in the event of a conversion error.
sourceconst: unstable · fn try_from(value: U) -> Result<T, <T as TryFrom<U>>8b7c:f320:99b9:690f:4595:cd17:293a:c069rror>Performs the conversion.

sourceimpl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>8b7c:f320:99b9:690f:4595:cd17:293a:c069rrorThe type returned in the event of a conversion error.
sourceconst: unstable · fn try_into(self) -> Result<U, <U as TryFrom<T>>8b7c:f320:99b9:690f:4595:cd17:293a:c069rror>Performs the conversion.



    
{'path': 'public/docs/rust/std/cell/struct.cell.html', 'source': 'DevDocs.IO'}