Struct lucia_lang::gc::Ref

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

Wraps a borrowed reference to a value in a RefCell box. A wrapper type for an immutably borrowed value from a RefCell<T>.

Implementations

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

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

Copies a Ref.

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

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

pub fn map<U: ?Sized, F>(orig: Ref<'a, T>, f: F) -> Ref<'a, U>where F: FnOnce(&T) -> &U,

Makes a new Ref for a component of the borrowed data.

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

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

pub fn filter_map<U: ?Sized, F>( orig: Ref<'a, T>, f: F ) -> Result<Ref<'a, U>, Self>where F: FnOnce(&T) -> Option<&U>,

Makes a new Ref for an optional component of the borrowed data. The original guard is returned as an Err(..) if the closure returns None.

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

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

pub fn map_split<U: ?Sized, V: ?Sized, F>( orig: Ref<'a, T>, f: F ) -> (Ref<'a, U>, Ref<'a, V>)where F: FnOnce(&T) -> (&U, &V),

Splits a Ref into multiple Refs for different components of the borrowed data.

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

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

Trait Implementations

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

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

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

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

Formats the value using the given formatter.