Struct std::cell::Cell

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

A mutable memory location.

See the module-level documentation for more.

Methods

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

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

impl<T> Cell<T>

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

Creates a new Cell containing the given value.

Examples

use std::cell::Cell;

let c = Cell::new(5);

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

Deprecated since 1.12.0

: renamed to as_ptr

🔬 This is a nightly-only experimental API. (as_unsafe_cell #27708)

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

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

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.

Examples

use std::cell::Cell;

let mut c = Cell::new(5);
*c.get_mut() += 1;

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

fn set(&self, val: T)

Sets the contained value.

Examples

use std::cell::Cell;

let c = Cell::new(5);

c.set(10);

fn swap(&self, other: &Cell<T>)

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

fn replace(&self, val: T) -> T

Replaces the contained value.

Examples

use std::cell::Cell;

let c = Cell::new(5);
let old = c.replace(10);

assert_eq!(5, old);

fn into_inner(self) -> T

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: Default

fn take(&self) -> T

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

Trait Implementations

impl<T> Eq for Cell<T> where T: Copy + Eq

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

impl<T> From<T> for Cell<T>

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

Performs the conversion.

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> Ord for Cell<T> where T: Copy + Ord

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

This method returns an Ordering between self and other.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Default for Cell<T> where T: Default

fn default() -> Cell<T>

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

impl<T> PartialOrd<Cell<T>> for Cell<T> where T: Copy + PartialOrd<T>

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

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

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

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

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.

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

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

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.

impl<T> !Sync for Cell<T>

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 ==.

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

This method tests for !=.

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