alloc::rc::Weak - Rust
Description: API documentation for the Rust `Weak` struct in crate `alloc`.
Keywords: rust, rustlang, rust-lang, Weak

# Struct alloc::rc::Weak 1.4.0 [−] [src]

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

`Weak` is a version of `Rc` that holds a non-owning reference to the managed value. The value is accessed by calling `upgrade` on the `Weak` pointer, which returns an `Option``<``Rc``<T>>`.

Since a `Weak` reference does not count towards ownership, it will not prevent the inner value from being dropped, and `Weak` itself makes no guarantees about the value still being present and may return `None` when `upgrade`d.

A `Weak` pointer is useful for keeping a temporary reference to the value within `Rc` without extending its lifetime. It is also used to prevent circular references between `Rc` pointers, since mutual owning references would never allow either `Rc` to be dropped. For example, a tree could have strong `Rc` pointers from parent nodes to children, and `Weak` pointers from children back to their parents.

The typical way to obtain a `Weak` pointer is to call `Rc::downgrade`.

## Methods

### `impl<T> Weak<T>`
[src]

#### `pub fn new() -> Weak<T>`
1.10.0
[src]

Constructs a new `Weak<T>`, allocating memory for `T` without initializing it. Calling `upgrade` on the return value always gives `None`.

# Examples

    use std::rc::Weak;

    let empty: Weak<i64> = Weak::new();
    assert!(empty.upgrade().is_none());

### `impl<T: ?Sized> Weak<T>`
[src]

#### `pub fn upgrade(&self) -> Option<Rc<T>>`
[src]

Attempts to upgrade the `Weak` pointer to an `Rc`, extending the lifetime of the value if successful.

Returns `None` if the value has since been dropped.

# Examples

    use std::rc::Rc;

    let five = Rc::new(5);

    let weak_five = Rc::downgrade(&five);

    let strong_five: Option<Rc<_>> = weak_five.upgrade();
    assert!(strong_five.is_some());

    // Destroy all strong pointers.
    drop(strong_five);
    drop(five);

    assert!(weak_five.upgrade().is_none());

## Trait Implementations

### `impl<T: ?Sized> !Send for Weak<T>`
[src]

### `impl<T: ?Sized> !Sync for Weak<T>`
[src]

### `impl<T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<Weak<U>> for Weak<T>`
[src]

### `impl<T: ?Sized> Drop for Weak<T>`
[src]

#### `fn drop(&mut self)`
[src]

Drops the `Weak` pointer.

# Examples

    use std::rc::{Rc, Weak};

    struct Foo;

    impl Drop for Foo {
        fn drop(&mut self) {
            println!("dropped!");
        }
    }

    let foo = Rc::new(Foo);
    let weak_foo = Rc::downgrade(&foo);
    let other_weak_foo = Weak::clone(&weak_foo);

    drop(weak_foo);   // Doesn't print anything
    drop(foo);        // Prints "dropped!"

    assert!(other_weak_foo.upgrade().is_none());

### `impl<T: ?Sized> Clone for Weak<T>`
[src]

#### `fn clone(&self) -> Weak<T>`
[src]

Makes a clone of the `Weak` pointer that points to the same value.

# Examples

    use std::rc::{Rc, Weak};

    let weak_five = Rc::downgrade(&Rc::new(5));

    Weak::clone(&weak_five);

#### `fn clone_from(&mut self, source: &Self)`
1.0.0
[src]

Performs copy-assignment from `source`. Read more

### `impl<T: ?Sized + Debug> Debug for Weak<T>`
[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter.

### `impl<T> Default for Weak<T>`
1.10.0
[src]

#### `fn default() -> Weak<T>`
[src]

Constructs a new `Weak<T>`, allocating memory for `T` without initializing it. Calling `upgrade` on the return value always gives `None`.

# Examples

    use std::rc::Weak;

    let empty: Weak<i64> = Default::default();
    assert!(empty.upgrade().is_none());

# 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`)