Enum Local 

pub enum Local<'local, T>
where
    T: RootKind + 'local,
{
    Rooted(&'local mut Rooted<T>),
    Mutable(MutableHandle<'local, T>),
    Handle(Handle<'local, T>),
}

Represents a local reference managed by the Garbage Collector. Prevents a local value that is currently being used from being garbage collected and causing undefined behaviour.

Variants

Rooted(&'local mut Rooted<T>)

Mutable(MutableHandle<'local, T>)

Handle(Handle<'local, T>)

Implementations

impl<'local, T: Copy + RootKind> Local<'local, T>

pub fn handle(&self) -> Handle<'local, T>

Forms a Handle to the Local which can be passed to SpiderMonkey APIs.

pub fn handle_mut(&mut self) -> MutableHandle<'local, T>

Forms a Handle to the Local which can be passed to SpiderMonkey APIs.

Panics

Panics when a Local::Handle is passed.

pub fn get(&self) -> T

impl<'local, T: RootKind> Local<'local, T>

pub(crate) fn new(cx: &Context, root: &'local mut Rooted<T>) -> Local<'local, T>

Creates a new Local. Context::root should be used instead.

pub fn from_handle(handle: Handle<'local, T>) -> Local<'local, T>

Creates a Local from a Handle.

pub fn from_handle_mut(handle: MutableHandle<'local, T>) -> Local<'local, T>

Creates a Local from a MutableHandle.

pub unsafe fn from_marked(ptr: *const T) -> Local<'local, T>

Creates a Local from a marked (pointer).

Safety

The pointer must point to a location marked by the Garbage Collector.

pub unsafe fn from_raw_handle(handle: RawHandle<T>) -> Local<'local, T>

Creates a Local from a raw handle.

Safety

The handle must be valid and still be recognised by the Garbage Collector.

pub unsafe fn from_marked_mut(ptr: *mut T) -> Local<'local, T>

Creates a Local from a marked mutable pointer;

Safety

The pointer must point to a location marked by the Garbage Collector.

pub unsafe fn from_raw_handle_mut( handle: RawMutableHandle<T>, ) -> Local<'local, T>

Creates a Local from a raw mutable handle;

Safety

The mutable handle must be valid and still be recognised by the Garbage Collector.

impl<'local, T: Copy + GCMethods + RootKind> Local<'local, T>

pub unsafe fn from_heap(heap: &'local Heap<T>) -> Local<'local, T>

Trait Implementations

impl<T: Copy + Debug + RootKind> Debug for Local<'_, T>

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

Formats the value using the given formatter.

impl<'b> From<Local<'b, *mut BigInt>> for BigInt<'b>

fn from(bi: Local<'b, *mut JSBigInt>) -> BigInt<'b>

Converts to this type from the input type.

impl<'f> From<Local<'f, *mut JSFunction>> for Function<'f>

fn from(function: Local<'f, *mut JSFunction>) -> Function<'f>

Converts to this type from the input type.

impl<'k> From<Local<'k, PropertyKey>> for PropertyKey<'k>

fn from(key: Local<'k, JSPropertyKey>) -> PropertyKey<'k>

Converts to this type from the input type.

impl<'o> From<Local<'o, *mut JSObject>> for Object<'o>

fn from(obj: Local<'o, *mut JSObject>) -> Object<'o>

Converts to this type from the input type.

impl<'o> From<Local<'o, *mut Symbol>> for Symbol<'o>

fn from(sym: Local<'o, *mut JSSymbol>) -> Symbol<'o>

Converts to this type from the input type.

impl<'pd> From<Local<'pd, PropertyDescriptor>> for PropertyDescriptor<'pd>

fn from(desc: Local<'pd, JSPropertyDescriptor>) -> PropertyDescriptor<'pd>

Converts to this type from the input type.

impl<'s> From<Local<'s, *mut JSScript>> for Script<'s>

fn from(script: Local<'s, *mut JSScript>) -> Script<'s>

Converts to this type from the input type.

impl<'s> From<Local<'s, *mut JSString>> for String<'s>

fn from(str: Local<'s, *mut JSString>) -> String<'s>

Converts to this type from the input type.

impl<'v> From<Local<'v, Value>> for Value<'v>

fn from(val: Local<'v, JSVal>) -> Value<'v>

Converts to this type from the input type.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 16 bytes

Size for each variant:

• Rooted: 8 bytes
• Mutable: 8 bytes
• Handle: 8 bytes