Struct PermanentRoot 

pub struct PermanentRoot(Heap<JSVal>);

A manual GC root that will exist until this PermanentRoot is dropped. Maintains a GC root for the contained value until this object is dropped.

Safety

The root (and the contained value) is only valid as long as this value is never moved after it is initialized. It should only be used inside of a container like Box or Rc and never extracted from it.

Tuple Fields

0: Heap<JSVal>

Implementations

impl PermanentRoot

pub unsafe fn init( &self, cx: &JSContext, object: *mut JSObject, name: &'static CStr, )

Add a GC root for the provided JS object.

Safety

• This method must only be called on a PermanentRoot that will not move for the remainder of its lifetime (e.g. inside of Box, Rc, etc.)
• This must only be called once per instance of PermanentRoot

Trait Implementations

impl Default for PermanentRoot

fn default() -> PermanentRoot

Returns the “default value” for a type.

impl Drop for PermanentRoot

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl MallocSizeOf for PermanentRoot

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl Traceable for PermanentRoot

unsafe fn trace(&self, tracer: *mut JSTracer)

Trace self.