Skip to main content

RootScope

Struct RootScope 

Source
pub struct RootScope<'a> { /* private fields */ }
Expand description

A RAII frame that roots a set of GcRefs and optionally chains to a parent RootSet.

Roots are added via RootScope::root and dropped automatically when the scope ends. A scope keeps its own roots live; the collector also walks the parent chain, so a nested scope’s roots supplement (never replace) its ancestors’.

Implementations§

Source§

impl<'a> RootScope<'a>

Source

pub fn new() -> Self

A fresh top-level scope with no parent.

Source

pub fn child(parent: &'a dyn RootSet) -> Self

A scope that chains onto parent; its roots are added to parent’s.

Source

pub fn root(&mut self, gcref: GcRef) -> GcRef

Register gcref as a root for the lifetime of this scope and return a copy of it. The returned GcRef is kept alive until the scope drops.

Called for its rooting side-effect; the returned copy is a convenience for chaining.

Source

pub fn root_count(&self) -> usize

Number of roots held directly by this scope (excluding the parent chain).

Trait Implementations§

Source§

impl Default for RootScope<'_>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl RootSet for RootScope<'_>

Source§

fn push_roots(&self, out: &mut Vec<GcRef>)

Push every root held by this set into out, in any order.

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for RootScope<'a>

§

impl<'a> !Send for RootScope<'a>

§

impl<'a> !Sync for RootScope<'a>

§

impl<'a> !UnwindSafe for RootScope<'a>

§

impl<'a> Freeze for RootScope<'a>

§

impl<'a> Unpin for RootScope<'a>

§

impl<'a> UnsafeUnpin for RootScope<'a>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.