Struct GcRef 

pub struct GcRef<'a, T: ?Sized + 'static> { /* private fields */ }

A wrapper type for an immutably borrowed value from a GcCell<T>.

Implementations

impl<'a, T: ?Sized> GcRef<'a, T>

pub unsafe fn cast<U>(orig: Self) -> GcRef<'a, U>

Casts to a GcRef of another type.

Safety

• The caller must ensure that T can be safely cast to U.

pub fn clone(orig: &GcRef<'a, T>) -> GcRef<'a, T>

Copies a GcCellRef.

The GcCell is already immutably borrowed, so this cannot fail.

This is an associated function that needs to be used as GcCellRef::clone(...). A Clone implementation or a method would interfere with the use of c.borrow().clone() to clone the contents of a GcCell.

pub fn try_map<U, F>(orig: Self, f: F) -> Option<GcRef<'a, U>>

where U: ?Sized, F: FnOnce(&T) -> Option<&U>,

Tries to make a new GcCellRef from a component of the borrowed data, returning None if the mapping function returns None.

The GcCell is already immutably borrowed, so this cannot fail.

This is an associated function that needs to be used as GcCellRef::try_map(...). A method would interfere with methods of the same name on the contents of a GcCellRef used through Deref.

pub fn map<U, F>(orig: Self, f: F) -> GcRef<'a, U>

where U: ?Sized, F: FnOnce(&T) -> &U,

Makes a new GcCellRef from a component of the borrowed data.

The GcCell is already immutably borrowed, so this cannot fail.

This is an associated function that needs to be used as GcCellRef::map(...). A method would interfere with methods of the same name on the contents of a GcCellRef used through Deref.

pub fn map_split<U, V, F>(orig: Self, f: F) -> (GcRef<'a, U>, GcRef<'a, V>)

where U: ?Sized, V: ?Sized, F: FnOnce(&T) -> (&U, &V),

Splits a GcCellRef into multiple GcCellRefs for different components of the borrowed data.

The GcCell is already immutably borrowed, so this cannot fail.

This is an associated function that needs to be used as GcCellRef::map_split(...). A method would interfere with methods of the same name on the contents of a GcCellRef used through Deref.

Trait Implementations

impl<T: ?Sized + Debug> Debug for GcRef<'_, T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Deref for GcRef<'_, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: ?Sized + Display> Display for GcRef<'_, T>

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

Formats the value using the given formatter.