Struct js::rust::RootedGuard

pub struct RootedGuard<'a, T: 'a + RootKind + GCMethods> { /* fields omitted */ }

Rust API for keeping a Rooted value in the context's root stack. Example usage: rooted!(in(cx) let x = UndefinedValue());. RootedGuard::new also works, but the macro is preferred.

Methods

impl<'a, T: 'a + RootKind + GCMethods> RootedGuard<'a, T>

pub fn new(cx: *mut JSContext, root: &'a mut Rooted<T>, initial: T) -> Self

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

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

pub fn get(&self) -> T where
    T: Copy, 

pub fn set(&mut self, v: T)

Trait Implementations

impl<'a, T: 'a + RootKind + GCMethods> Deref for RootedGuard<'a, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'a, T: 'a + RootKind + GCMethods> DerefMut for RootedGuard<'a, T>

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

Mutably dereferences the value.

impl<'a, T: 'a + RootKind + GCMethods> Drop for RootedGuard<'a, T>

fn drop(&mut self)

Executes the destructor for this type.