Struct moving_gc_arena::Weak

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

A weak index into a region.

This index will never prevent an object from being collected, but can be used to test if an object has been collected, or access it as normal.

Implementations

impl<T> Weak<T>

pub fn get<'a>(&self, r: &'a Region<T>) -> &'a T

Gets the value at this location, when passed the correct region. As with Ix, the behavior when the region or location is unspecified (but is still safe).

pub fn get_mut<'a>(&self, r: &'a mut Region<T>) -> &'a mut T

pub fn try_get<'a>(&self, r: &'a Region<T>) -> Result<&'a T, Error>

Try to get a reference to this data, possibly returning an error.

If the region is correct, then an error always indicates that the pointed-to entry is no longer valid

pub fn try_get_mut<'a>(&self, r: &'a mut Region<T>) -> Result<&'a mut T, Error>

pub fn ix(&self) -> Ix<T>

Get the raw index pointed to this by weak. This method will panic if ix is expired. Use try_ix to handle failure

pub fn try_ix(&self) -> Result<Ix<T>, Error>

pub fn root(&self, region: &Region<T>) -> Root<T>

pub fn try_root(&self, region: &Region<T>) -> Result<Root<T>, Error>

Trait Implementations

impl<T> Clone for Weak<T>

pub fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Weak<T>

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Eq for Weak<T>

impl<T> PartialEq<Weak<T>> for Weak<T>

pub fn eq(&self, other: &Weak<T>) -> bool

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

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

This method tests for !=.