Struct RootedGuard

pub struct RootedGuard<'a, T: 'a + RootKind> {
    root: *mut Rooted<T>,
    anchor: PhantomData<&'a mut Rooted<T>>,
}

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.

Fields

root: *mut Rooted<T>

anchor: PhantomData<&'a mut Rooted<T>>

Implementations

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

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

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

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

pub fn as_ptr(&self) -> *mut T

pub unsafe fn as_mut<'b>(&'b mut self) -> &'b mut T

where 'a: 'b,

Safety: GC must not run during the lifetime of the returned reference.

pub fn get(&self) -> T

where T: Copy,

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

impl<'a, T> RootedGuard<'a, Option<T>>

where Option<T>: RootKind,

pub fn take(&mut self) -> Option<T>

Trait Implementations

impl<'a, T: 'a + RootKind> 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> Drop for RootedGuard<'a, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, const N: usize> From<&RootedGuard<'a, ValueArray<N>>> for HandleValueArray

fn from(array: &RootedGuard<'a, ValueArray<N>>) -> HandleValueArray

Converts to this type from the input type.