Struct mozjs::jsapi::Handle

#[repr(C)]
pub struct Handle<T> {
    pub _phantom_0: PhantomData<UnsafeCell<T>>,
    pub ptr: *const T,
}

Reference to a T that has been rooted elsewhere. This is most useful as a parameter type, which guarantees that the T lvalue is properly rooted. See “Move GC Stack Rooting” above.

If you want to add additional methods to Handle for a specific specialization, define a HandleOperations specialization containing them.

Fields

_phantom_0: PhantomData<UnsafeCell<T>>

ptr: *const T

Implementations

impl<T> Handle<T>

pub fn get(&self) -> T

where T: Copy,

pub unsafe fn from_marked_location(ptr: *const T) -> Handle<T>

impl Handle<Value>

pub fn null() -> Handle<Value>

pub fn undefined() -> Handle<Value>

impl Handle<*mut JSObject>

pub fn null() -> Handle<*mut JSObject>

Trait Implementations

impl<T> Clone for Handle<T>

where T: Clone,

fn clone(&self) -> Handle<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Handle<T>

where T: Debug,

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

Formats the value using the given formatter.

impl From<Handle<Value>> for HandleValueArray

fn from(handle: Handle<Value>) -> HandleValueArray

Converts to this type from the input type.

impl<T> From<T> for Handle<<T as IntoHandle>::Target>

where T: IntoHandle,

fn from(value: T) -> Handle<<T as IntoHandle>::Target>

Converts to this type from the input type.

impl<T> PartialEq for Handle<T>

where T: PartialEq,

fn eq(&self, other: &Handle<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Deref for Handle<T>

type Target = T

The resulting type after dereferencing.

fn deref<'a>(&'a self) -> &'a T

Dereferences the value.

impl<T> Copy for Handle<T>

where T: Copy,

impl<T> StructuralPartialEq for Handle<T>