Text of rust.docs.kernel.org › core › cell › struct.Cell.html as Styx crawled it on Nov 19, 2026. The page may have changed since. Only its words are kept, without pictures or layout, and only the first part of a long page.

Open the live page

Cell in core::cell - Rust

Skip to main content Cell core :: cell Struct Cell 1.6.0 · Source #[repr(transparent)] pub struct Cell<T: ? Sized > { /* private fields */ } Expand description A mutable memory location. § Memory layout Cell<T> has the same memory layout and caveats as UnsafeCell<T> . In particular, this means that Cell<T> has the same in-memory representation as its inner type T . § 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 § Source § impl<T> Cell <T> 1.0.0 (const: 1.24.0) · Source pub const fn new (value: T) -> Cell <T> Creates a new Cell containing the given value. § Examples use std::cell::Cell; let c = Cell::new( 5 ); 1.0.0 (const: unstable ) · Source pub fn set (&self, val: T) where T:, Sets the contained value. § Examples use std::cell::Cell; let c = Cell::new( 5 ); c.set( 10 ); 1.17.0 · Source pub fn swap (&self, other: &Self) Swaps the values of two Cell s.

The difference with std::mem::swap is that this function doesn’t require a &mut reference. § Panics This function will panic if self and other are different Cell s that partially overlap. (Using just standard library methods, it is impossible to create such partially overlapping Cell s. However, unsafe code is allowed to e.g. create two &Cell<[i32; 2]> that partially overlap.) § 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()); 1.17.0 (const: 1.88.0) · Source pub const fn replace (&self, val: T) -> T 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 ); 1.17.0 (const: 1.83.0) · Source pub const fn into_inner (self) -> T Unwraps the value, consuming the cell. § Examples use std::cell::Cell; let c = Cell::new( 5 ); let five = c.into_inner(); assert_eq! (five, 5 ); Source § impl<T: Copy > Cell <T> 1.0.0 (const: 1.88.0) · Source pub const fn get (&self) -> T Returns a copy of the contained value. § Examples use std::cell::Cell; let c = Cell::new( 5 ); let five = c.get(); 1.88.0 (const: unstable ) · Source pub fn update (&self, f: impl FnOnce (T) -> T) where T:, Updates the contained value using a function. § Examples use std::cell::Cell; let c = Cell::new( 5 ); c.update(|x| x + 1 ); assert_eq! (c.get(), 6 ); Source § impl<T: ?

Sized > Cell <T> 1.12.0 (const: 1.32.0) · Source pub const fn as_ptr (&self) -> *mut T 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(); 1.11.0 (const: 1.88.0) · Source pub const 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 std::cell::Cell; let mut c = Cell::new( 5 ); * c.get_mut() += 1 ; assert_eq! (c.get(), 6 ); 1.37.0 (const: 1.88.0) · Source pub const fn from_mut (t: &mut T ) -> & Cell <T> 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 ); Source § impl<T: Default > Cell <T> 1.17.0 (const: unstable ) · Source pub fn take (&self) -> T where T: Default , Takes the value of the cell, leaving Default::default() in its place. § Examples use std::cell::Cell; let c = Cell::new( 5 ); let five = c.take(); assert_eq! (five, 5 ); assert_eq! (c.into_inner(), 0 ); Source § impl<T> Cell < [T] > 1.37.0 (const: 1.88.0) · Source pub const fn as_slice_of_cells (&self) -> &[ Cell <T>] 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 ); Source § impl<T, const N: usize > Cell < [T; N] > 1.91.0 (const: 1.91.0) · Source pub const fn as_array_of_cells (&self) -> &[ Cell <T>; N ] Returns a &[Cell<T>; N] from a &Cell<[T; N]> § Examples use std::cell::Cell; let mut array: [i32; 3 ] = [ 1 , 2 , 3 ]; let cell_array: & Cell<[i32; 3 ]> = Cell::from_mut( &mut array); let array_cell: & [Cell<i32>; 3 ] = cell_array.as_array_of_cells(); Source § impl<T: CloneFromCell > Cell <T> Source pub fn get_cloned (&self) -> Self 🔬 This is a nightly-only experimental API. ( cell_get_cloned #145329 ) Get a clone of the Cell that contains a copy of the original value.

This allows a cheaply Clone -able type like an Rc to be stored in a Cell , exposing the cheaper clone() method. § Examples #![feature(cell_get_cloned)] use core::cell::Cell; use std::rc::Rc; let rc = Rc::new( 1usize ); let c1 = Cell::new(rc); let c2 = c1.get_cloned(); assert_eq! ( * c2.into_inner(), 1 ); Trait Implementations § 1.0.0 · Source § impl<T: ? Sized > ! Sync for Cell <T> 1.95.0 · Source § impl<T, const N: usize > AsRef <[ Cell <T>; N ]> for Cell < [T; N] > Source § fn as_ref (&self) -> &[ Cell <T>; N ] Converts this type into a shared reference of the (usually inferred) input type.

1.95.0 · Source § impl<T, const N: usize > AsRef <[ Cell <T>]> for Cell < [T; N] > Source § fn as_ref (&self) -> &[ Cell <T>] Converts this type into a shared reference of the (usually inferred) input type. 1.95.0 · Source § impl<T> AsRef <[ Cell <T>]> for Cell < [T] > Source § fn as_ref (&self) -> &[ Cell <T>] Converts this type into a shared reference of the (usually inferred) input type. 1.0.0 · Source § impl<T: Copy > Clone for Cell <T> Source § fn clone (&self) -> Cell <T> Returns a duplicate of the value.

Read more 1.0.0 (const: unstable ) · Source § fn clone_from (&mut self, source: &Self) where Self:, Performs copy-assignment from source . Read more Source § impl<T: CoerceUnsized <U>, U> CoerceUnsized < Cell <U>> for Cell <T> 1.0.0 · Source § impl<T: Copy + Debug > Debug for Cell <T> Source § fn fmt (&self, f: &mut Formatter <'_>) -> Result Formats the value using the given formatter. Read more 1.0.0 (const: unstable ) · Source § impl<T: Default > Default for Cell <T> Source § fn default () -> Cell <T> Creates a Cell<T> , with the Default value for T.

Source § impl<T: DispatchFromDyn <U>, U> DispatchFromDyn < Cell <U>> for Cell <T> 1.2.0 · Source § impl<T: Eq + Copy > Eq for Cell <T> 1.12.0 (const: unstable ) · Source § impl<T> From <T> for Cell <T> Source § fn from (t: T) -> Cell <T> Creates a new Cell<T> containing the given value. 1.10.0 · Source § impl<T: Ord + Copy > Ord for Cell <T> Source § fn cmp (&self, other: & Cell <T>) -> Ordering This method returns an Ordering between self and other .

Read more 1.21.0 (const: unstable ) · Source § fn max (self, other: Self) -> Self where Self: Sized , Compares and returns the maximum of two values. Read more 1.21.0 (const: unstable ) · Source § fn min (self, other: Self) -> Self where Self: Sized , Compares and returns

The rest of this page is on the live site.