std::cell::Cell - Rust
Description: API documentation for the Rust `Cell` struct in crate `std`.
Keywords: rust, rustlang, rust-lang, Cell

# Struct std::cell::Cell 1.0.0 [−] [src]

    pub struct Cell<T> { /* fields omitted */ }

A mutable memory location that admits only `Copy` data.

See the module-level documentation for more.

## Methods

### `impl<T> Cell<T> where T: Copy`

#### `fn new(value: T) -> Cell<T>`

Creates a new `Cell` containing the given value.

# Examples

    use std::cell::Cell;

    let c = Cell::new(5);Run

#### `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();Run

#### `fn set(&self, value: T)`

Sets the contained value.

# Examples

    use std::cell::Cell;

    let c = Cell::new(5);

    c.set(10);Run

#### `fn as_unsafe_cell(&self) -> &UnsafeCell<T>`

Deprecated since 1.12.0

: renamed to as_ptr

Unstable (`as_unsafe_cell` #27708)

: renamed to as_ptr

Returns a reference to the underlying `UnsafeCell`.

# Examples

    #![feature(as_unsafe_cell)]

    use std::cell::Cell;

    let c = Cell::new(5);

    let uc = c.as_unsafe_cell();Run

#### `fn as_ptr(&self) -> *mut T`
1.12.0

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();Run

#### `fn get_mut(&mut self) -> &mut T`
1.11.0

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);Run

## Trait Implementations

### `impl<T> Eq for Cell<T> where T: Copy + Eq`
1.2.0

### `impl<T> PartialOrd<Cell<T>> for Cell<T> where T: Copy + PartialOrd<T>`
1.10.0

#### `fn partial_cmp(&self, other: &Cell<T>) -> Option<Ordering>`

This method returns an ordering between `self` and `other` values if one exists. Read more

#### `fn lt(&self, other: &Cell<T>) -> bool`

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

#### `fn le(&self, other: &Cell<T>) -> bool`

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

#### `fn gt(&self, other: &Cell<T>) -> bool`

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

#### `fn ge(&self, other: &Cell<T>) -> bool`

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

### `impl<T, U> CoerceUnsized<Cell<U>> for Cell<T> where T: CoerceUnsized<U>`

### `impl<T> From<T> for Cell<T> where T: Copy`
1.12.0

#### `fn from(t: T) -> Cell<T>`

Performs the conversion.

### `impl<T> !Sync for Cell<T>`

### `impl<T> Send for Cell<T> where T: Send`

### `impl<T> Clone for Cell<T> where T: Copy`

#### `fn clone(&self) -> Cell<T>`

Returns a copy of the value. Read more

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

Performs copy-assignment from `source`. Read more

### `impl<T> Ord for Cell<T> where T: Copy + Ord`
1.10.0

#### `fn cmp(&self, other: &Cell<T>) -> Ordering`

This method returns an `Ordering` between `self` and `other`. Read more

### `impl<T> Default for Cell<T> where T: Copy + Default`

#### `fn default() -> Cell<T>`

Creates a `Cell<T>`, with the `Default` value for T.

### `impl<T> Debug for Cell<T> where T: Copy + Debug`

#### `fn fmt(&self, f: &mut Formatter) -> Result<(), Error>`

Formats the value using the given formatter.

### `impl<T> PartialEq<Cell<T>> for Cell<T> where T: Copy + PartialEq<T>`

#### `fn eq(&self, other: &Cell<T>) -> bool`

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

#### `fn ne(&self, other: &Rhs) -> bool`

This method tests for `!=`.

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)