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

# 1.0.0[−][src]Struct core::cell::RefCell

    pub struct RefCell<T: ?Sized> { /* fields omitted */ }

A mutable memory location with dynamically checked borrow rules

See the module-level documentation for more.

## Methods

###

`impl<T> RefCell<T>`

[src]

####

`pub const fn new(value: T) -> RefCell<T>`

[src]

Creates a new `RefCell` containing `value`.

# Examples

    use std::cell::RefCell;

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

####

`pub fn into_inner(self) -> T`

[src]

Consumes the `RefCell`, returning the wrapped value.

# Examples

    use std::cell::RefCell;

    let c = RefCell::new(5);

    let five = c.into_inner();Run

####

`pub fn replace(&self, t: T) -> T`

1.24.0
[src]

Replaces the wrapped value with a new one, returning the old value, without deinitializing either one.

This function corresponds to `std::mem::replace`.

# Panics

Panics if the value is currently borrowed.

# Examples

    use std::cell::RefCell;
    let cell = RefCell::new(5);
    let old_value = cell.replace(6);
    assert_eq!(old_value, 5);
    assert_eq!(cell, RefCell::new(6));Run

####

`pub fn replace_with<F: FnOnce(&mut T) -> T>(&self, f: F) -> T`

[src]

🔬 This is a nightly-only experimental API. (`refcell_replace_swap` #43570)

Replaces the wrapped value with a new one computed from `f`, returning the old value, without deinitializing either one.

This function corresponds to `std::mem::replace`.

# Panics

Panics if the value is currently borrowed.

# Examples

    #![feature(refcell_replace_swap)]
    use std::cell::RefCell;
    let cell = RefCell::new(5);
    let old_value = cell.replace_with(|&mut old| old + 1);
    assert_eq!(old_value, 5);
    assert_eq!(cell, RefCell::new(6));Run

####

`pub fn swap(&self, other: &Self)`

1.24.0
[src]

Swaps the wrapped value of `self` with the wrapped value of `other`, without deinitializing either one.

This function corresponds to `std::mem::swap`.

# Panics

Panics if the value in either `RefCell` is currently borrowed.

# Examples

    use std::cell::RefCell;
    let c = RefCell::new(5);
    let d = RefCell::new(6);
    c.swap(&d);
    assert_eq!(c, RefCell::new(6));
    assert_eq!(d, RefCell::new(5));Run

###

`impl<T: ?Sized> RefCell<T>`

[src]

####

`pub fn borrow(&self) -> Ref<T>`

[src]

Immutably borrows the wrapped value.

The borrow lasts until the returned `Ref` exits scope. Multiple immutable borrows can be taken out at the same time.

# Panics

Panics if the value is currently mutably borrowed. For a non-panicking variant, use `try_borrow`.

# Examples

    use std::cell::RefCell;

    let c = RefCell::new(5);

    let borrowed_five = c.borrow();
    let borrowed_five2 = c.borrow();Run

An example of panic:

    use std::cell::RefCell;
    use std::thread;

    let result = thread::spawn(move || {
       let c = RefCell::new(5);
       let m = c.borrow_mut();

       let b = c.borrow(); // this causes a panic
    }).join();

    assert!(result.is_err());Run

####

`pub fn try_borrow(&self) -> Result<Ref<T>, BorrowError>`

1.13.0
[src]

Immutably borrows the wrapped value, returning an error if the value is currently mutably borrowed.

The borrow lasts until the returned `Ref` exits scope. Multiple immutable borrows can be taken out at the same time.

This is the non-panicking variant of `borrow`.

# Examples

    use std::cell::RefCell;

    let c = RefCell::new(5);

    {
        let m = c.borrow_mut();
        assert!(c.try_borrow().is_err());
    }

    {
        let m = c.borrow();
        assert!(c.try_borrow().is_ok());
    }Run

####

`pub fn borrow_mut(&self) -> RefMut<T>`

[src]

Mutably borrows the wrapped value.

The borrow lasts until the returned `RefMut` or all `RefMut`s derived from it exit scope. The value cannot be borrowed while this borrow is active.

# Panics

Panics if the value is currently borrowed. For a non-panicking variant, use `try_borrow_mut`.

# Examples

    use std::cell::RefCell;

    let c = RefCell::new(5);

    *c.borrow_mut() = 7;

    assert_eq!(*c.borrow(), 7);Run

An example of panic:

    use std::cell::RefCell;
    use std::thread;

    let result = thread::spawn(move || {
       let c = RefCell::new(5);
       let m = c.borrow();

       let b = c.borrow_mut(); // this causes a panic
    }).join();

    assert!(result.is_err());Run

####

`pub fn try_borrow_mut(&self) -> Result<RefMut<T>, BorrowMutError>`

1.13.0
[src]

Mutably borrows the wrapped value, returning an error if the value is currently borrowed.

The borrow lasts until the returned `RefMut` or all `RefMut`s derived from it exit scope. The value cannot be borrowed while this borrow is active.

This is the non-panicking variant of `borrow_mut`.

# Examples

    use std::cell::RefCell;

    let c = RefCell::new(5);

    {
        let m = c.borrow();
        assert!(c.try_borrow_mut().is_err());
    }

    assert!(c.try_borrow_mut().is_ok());Run

####

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

1.12.0
[src]

Returns a raw pointer to the underlying data in this cell.

# Examples

    use std::cell::RefCell;

    let c = RefCell::new(5);

    let ptr = c.as_ptr();Run

####

`pub fn get_mut(&mut self) -> &mut T`

1.11.0
[src]

Returns a mutable reference to the underlying data.

This call borrows `RefCell` mutably (at compile-time) so there is no need for dynamic checks.

However be cautious: this method expects `self` to be mutable, which is generally not the case when using a `RefCell`. Take a look at the `borrow_mut` method instead if `self` isn't mutable.

Also, please be aware that this method is only for special circumstances and is usually not what you want. In case of doubt, use `borrow_mut` instead.

# Examples

    use std::cell::RefCell;

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

    assert_eq!(c, RefCell::new(6));Run

## Trait Implementations

###

`impl<T: ?Sized> Send for RefCell<T> where T: Send,`

[src]

###

`impl<T: ?Sized> !Sync for RefCell<T>`

[src]

###

`impl<T: CoerceUnsized<U>, U> CoerceUnsized<RefCell<U>> for RefCell<T>`

[src]

###

`impl<T: ?Sized + PartialEq> PartialEq<RefCell<T>> for RefCell<T>`

[src]

####

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

[src]

# Panics

Panics if the value in either `RefCell` is currently borrowed.

####

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

[src]

This method tests for `!=`.

###

`impl<T: ?Sized + Eq> Eq for RefCell<T>`

1.2.0
[src]

###

`impl<T: ?Sized + Ord> Ord for RefCell<T>`

1.10.0
[src]

####

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

[src]

# Panics

Panics if the value in either `RefCell` is currently borrowed.

####

`fn max(self, other: Self) -> Self where Self: Sized,`

1.21.0
[src]

Compares and returns the maximum of two values. Read more

####

`fn min(self, other: Self) -> Self where Self: Sized,`

1.21.0
[src]

Compares and returns the minimum of two values. Read more

###

`impl<T: ?Sized + PartialOrd> PartialOrd<RefCell<T>> for RefCell<T>`

1.10.0
[src]

####

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

[src]

# Panics

Panics if the value in either `RefCell` is currently borrowed.

####

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

[src]

# Panics

Panics if the value in either `RefCell` is currently borrowed.

####

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

[src]

# Panics

Panics if the value in either `RefCell` is currently borrowed.

####

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

[src]

# Panics

Panics if the value in either `RefCell` is currently borrowed.

####

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

[src]

# Panics

Panics if the value in either `RefCell` is currently borrowed.

###

`impl<T: Clone> Clone for RefCell<T>`

[src]

####

`fn clone(&self) -> RefCell<T>`

[src]

# Panics

Panics if the value is currently mutably borrowed.

####

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

[src]

Performs copy-assignment from `source`. Read more

###

`impl<T: Default> Default for RefCell<T>`

[src]

####

`fn default() -> RefCell<T>`

[src]

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

###

`impl<T> From<T> for RefCell<T>`

1.12.0
[src]

####

`fn from(t: T) -> RefCell<T>`

[src]

Performs the conversion.

###

`impl<T: ?Sized + Debug> Debug for RefCell<T>`

[src]

####

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

[src]

Formats the value using the given formatter. Read more

## Blanket Implementations

###

`impl<T, U> Into for T where U: From<T>,`

[src]

####

`fn into(Self) -> U`

[src]

Performs the conversion.

###

`impl<T> From for T`

[src]

####

`fn from(T) -> T`

[src]

Performs the conversion.

###

`impl<T, U> TryInto for T where U: TryFrom<T>,`

[src]

#### `type Error = <U as TryFrom<T>>::Error`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

`fn try_into(Self) -> Result<U, <U as TryFrom<T>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

`fn try_from(U) -> Result<T, <T as TryFrom<U>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T> Borrow for T where T: ?Sized,`

[src]

####

`fn borrow(&Self) -> &T`

[src]

Immutably borrows from an owned value. Read more

###

`impl<T> BorrowMut for T where T: ?Sized,`

[src]

####

`fn borrow_mut(&mut Self) -> &mut T`

[src]

Mutably borrows from an owned value. Read more

###

`impl<T> Any for T where T: 'static + ?Sized,`

[src]

####

`fn get_type_id(&Self) -> TypeId`

[src]

🔬 This is a nightly-only experimental API. (`get_type_id` #27745)

this method will likely be replaced by an associated static

Gets the `TypeId` of `self`. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse 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`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)