Struct bones_framework::prelude::piccolo::Registry

pub struct Registry<'gc> { /* private fields */ }

Implementations

impl<'gc> Registry<'gc>

pub fn new(mc: &Mutation<'gc>) -> Registry<'gc>

pub fn roots(&self) -> DynamicRootSet<'gc>

pub fn singleton<S>(&self, ctx: Context<'gc>) -> &'gc <S as Rootable<'gc>>::Root

where S: for<'a> Rootable<'a>, <S as Rootable<'gc>>::Root: Singleton<'gc>,

Create an instance of a type that exists at most once per Lua instance.

If the type has already been created, returns the already created instance, otherwise calls S::create to create a new instance and returns it.

pub fn stash<S>( &self, mc: &Mutation<'gc>, s: S, ) -> <S as Stashable<'gc>>::Stashed

where S: Stashable<'gc>,

“Stash” a value with a 'gc branding lifetime, creating a 'static handle to it.

This is a wrapper around an internal gc-arena::DynamicRootSet that makes it a little simpler to work with common piccolo types without having to manually specify Rootable projections.

It can be implemented for external types by implementing the Stashable trait.

pub fn fetch<F>(&self, f: &F) -> <F as Fetchable<'gc>>::Fetched

where F: Fetchable<'gc>,

“Fetch” the real value for a handle that has been returned from Registry::stash.

It can be implemented for external types by implementing the Fetchable trait.

Trait Implementations

impl<'gc> Clone for Registry<'gc>

fn clone(&self) -> Registry<'gc>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'gc> Collect for Registry<'gc>

fn needs_trace() -> bool

As an optimization, if this type can never hold a Gc pointer and trace is unnecessary to call, you may implement this method and return false. The default implementation returns true, signaling that Collect::trace must be called.

fn trace(&self, cc: &Collection)

Must call Collect::trace on all held Gc pointers. If this type holds inner types that implement Collect, a valid implementation would simply call Collect::trace on all the held values to ensure this.

impl<'gc> Copy for Registry<'gc>