Struct script::dom::bindings::trace::RootedTraceableBox

pub struct RootedTraceableBox<T: 'static + JSTraceable> {
    ptr: *mut T,
}

Roots any JSTraceable thing

If you have a valid DomObject, use DomRoot. If you have GC things like *mut JSObject or JSVal, use rooted!. If you have an arbitrary number of DomObjects to root, use rooted_vec!. If you know what you’re doing, use this.

Fields

ptr: *mut T

Implementations

impl<T: JSTraceable + 'static> RootedTraceableBox<T>

pub fn new(traceable: T) -> RootedTraceableBox<T>

DomRoot a JSTraceable thing for the life of this RootedTraceableBox

pub fn from_box(boxed_traceable: Box<T>) -> RootedTraceableBox<T>

Consumes a boxed JSTraceable and roots it for the life of this RootedTraceableBox.

impl<T> RootedTraceableBox<Heap<T>>where
    Heap<T>: JSTraceable + 'static,
    T: GCMethods + Copy,

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

Trait Implementations

impl<T: JSTraceable + Default> Default for RootedTraceableBox<T>

fn default() -> RootedTraceableBox<T>

Returns the “default value” for a type.

impl<T: JSTraceable> Deref for RootedTraceableBox<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: JSTraceable> DerefMut for RootedTraceableBox<T>

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

Mutably dereferences the value.

impl<T: JSTraceable + 'static> Drop for RootedTraceableBox<T>

fn drop(&mut self)

Executes the destructor for this type.

impl FromJSValConvertible for RootedTraceableBox<BluetoothDataFilterInit>

type Config = ()

Optional configurable behaviour switch; use () for no configuration.

unsafe fn from_jsval(
    cx: *mut JSContext,
    value: HandleValue<'_>,
    _option: ()
) -> Result<ConversionResult<RootedTraceableBox<BluetoothDataFilterInit>>, ()>

Convert val to type Self. Optional configuration of type T can be passed as the option argument. If it returns Err(()), a JSAPI exception is pending. If it returns Ok(Failure(reason)), there is no pending JSAPI exception.

impl FromJSValConvertible for RootedTraceableBox<CustomEventInit>

type Config = ()

Optional configurable behaviour switch; use () for no configuration.

unsafe fn from_jsval(
    cx: *mut JSContext,
    value: HandleValue<'_>,
    _option: ()
) -> Result<ConversionResult<RootedTraceableBox<CustomEventInit>>, ()>

Convert val to type Self. Optional configuration of type T can be passed as the option argument. If it returns Err(()), a JSAPI exception is pending. If it returns Ok(Failure(reason)), there is no pending JSAPI exception.

impl FromJSValConvertible for RootedTraceableBox<ErrorEventInit>

type Config = ()

Optional configurable behaviour switch; use () for no configuration.

unsafe fn from_jsval(
    cx: *mut JSContext,
    value: HandleValue<'_>,
    _option: ()
) -> Result<ConversionResult<RootedTraceableBox<ErrorEventInit>>, ()>

Convert val to type Self. Optional configuration of type T can be passed as the option argument. If it returns Err(()), a JSAPI exception is pending. If it returns Ok(Failure(reason)), there is no pending JSAPI exception.

impl FromJSValConvertible for RootedTraceableBox<ExtendableMessageEventInit>

type Config = ()

Optional configurable behaviour switch; use () for no configuration.

unsafe fn from_jsval(
    cx: *mut JSContext,
    value: HandleValue<'_>,
    _option: ()
) -> Result<ConversionResult<RootedTraceableBox<ExtendableMessageEventInit>>, ()>

Convert val to type Self. Optional configuration of type T can be passed as the option argument. If it returns Err(()), a JSAPI exception is pending. If it returns Ok(Failure(reason)), there is no pending JSAPI exception.

impl FromJSValConvertible for RootedTraceableBox<GPUShaderModuleDescriptor>

type Config = ()

Optional configurable behaviour switch; use () for no configuration.

unsafe fn from_jsval(
    cx: *mut JSContext,
    value: HandleValue<'_>,
    _option: ()
) -> Result<ConversionResult<RootedTraceableBox<GPUShaderModuleDescriptor>>, ()>

Convert val to type Self. Optional configuration of type T can be passed as the option argument. If it returns Err(()), a JSAPI exception is pending. If it returns Ok(Failure(reason)), there is no pending JSAPI exception.

impl<T> FromJSValConvertible for RootedTraceableBox<Heap<T>>where
    T: FromJSValConvertible + GCMethods + Copy,
    Heap<T>: JSTraceable + Default,

type Config = <T as FromJSValConvertible>::Config

Optional configurable behaviour switch; use () for no configuration.

unsafe fn from_jsval(
    cx: *mut JSContext,
    value: HandleValue<'_>,
    config: Self::Config
) -> Result<ConversionResult<Self>, ()>

Convert val to type Self. Optional configuration of type T can be passed as the option argument. If it returns Err(()), a JSAPI exception is pending. If it returns Ok(Failure(reason)), there is no pending JSAPI exception.

impl FromJSValConvertible for RootedTraceableBox<IterableKeyAndValueResult>

type Config = ()

Optional configurable behaviour switch; use () for no configuration.

unsafe fn from_jsval(
    cx: *mut JSContext,
    value: HandleValue<'_>,
    _option: ()
) -> Result<ConversionResult<RootedTraceableBox<IterableKeyAndValueResult>>, ()>

Convert val to type Self. Optional configuration of type T can be passed as the option argument. If it returns Err(()), a JSAPI exception is pending. If it returns Ok(Failure(reason)), there is no pending JSAPI exception.

impl FromJSValConvertible for RootedTraceableBox<IterableKeyOrValueResult>

type Config = ()

Optional configurable behaviour switch; use () for no configuration.

unsafe fn from_jsval(
    cx: *mut JSContext,
    value: HandleValue<'_>,
    _option: ()
) -> Result<ConversionResult<RootedTraceableBox<IterableKeyOrValueResult>>, ()>

Convert val to type Self. Optional configuration of type T can be passed as the option argument. If it returns Err(()), a JSAPI exception is pending. If it returns Ok(Failure(reason)), there is no pending JSAPI exception.

impl FromJSValConvertible for RootedTraceableBox<MessageEventInit>

type Config = ()

Optional configurable behaviour switch; use () for no configuration.

unsafe fn from_jsval(
    cx: *mut JSContext,
    value: HandleValue<'_>,
    _option: ()
) -> Result<ConversionResult<RootedTraceableBox<MessageEventInit>>, ()>

Convert val to type Self. Optional configuration of type T can be passed as the option argument. If it returns Err(()), a JSAPI exception is pending. If it returns Ok(Failure(reason)), there is no pending JSAPI exception.

impl FromJSValConvertible for RootedTraceableBox<PopStateEventInit>

type Config = ()

Optional configurable behaviour switch; use () for no configuration.

unsafe fn from_jsval(
    cx: *mut JSContext,
    value: HandleValue<'_>,
    _option: ()
) -> Result<ConversionResult<RootedTraceableBox<PopStateEventInit>>, ()>

Convert val to type Self. Optional configuration of type T can be passed as the option argument. If it returns Err(()), a JSAPI exception is pending. If it returns Ok(Failure(reason)), there is no pending JSAPI exception.

impl FromJSValConvertible for RootedTraceableBox<PostMessageOptions>

type Config = ()

Optional configurable behaviour switch; use () for no configuration.

unsafe fn from_jsval(
    cx: *mut JSContext,
    value: HandleValue<'_>,
    _option: ()
) -> Result<ConversionResult<RootedTraceableBox<PostMessageOptions>>, ()>

Convert val to type Self. Optional configuration of type T can be passed as the option argument. If it returns Err(()), a JSAPI exception is pending. If it returns Ok(Failure(reason)), there is no pending JSAPI exception.

impl FromJSValConvertible for RootedTraceableBox<PromiseRejectionEventInit>

type Config = ()

Optional configurable behaviour switch; use () for no configuration.

unsafe fn from_jsval(
    cx: *mut JSContext,
    value: HandleValue<'_>,
    _option: ()
) -> Result<ConversionResult<RootedTraceableBox<PromiseRejectionEventInit>>, ()>

Convert val to type Self. Optional configuration of type T can be passed as the option argument. If it returns Err(()), a JSAPI exception is pending. If it returns Ok(Failure(reason)), there is no pending JSAPI exception.

impl FromJSValConvertible for RootedTraceableBox<RequestInit>

type Config = ()

Optional configurable behaviour switch; use () for no configuration.

unsafe fn from_jsval(
    cx: *mut JSContext,
    value: HandleValue<'_>,
    _option: ()
) -> Result<ConversionResult<RootedTraceableBox<RequestInit>>, ()>

Convert val to type Self. Optional configuration of type T can be passed as the option argument. If it returns Err(()), a JSAPI exception is pending. If it returns Ok(Failure(reason)), there is no pending JSAPI exception.

impl FromJSValConvertible for RootedTraceableBox<TestDictionary>

type Config = ()

Optional configurable behaviour switch; use () for no configuration.

unsafe fn from_jsval(
    cx: *mut JSContext,
    value: HandleValue<'_>,
    _option: ()
) -> Result<ConversionResult<RootedTraceableBox<TestDictionary>>, ()>

Convert val to type Self. Optional configuration of type T can be passed as the option argument. If it returns Err(()), a JSAPI exception is pending. If it returns Ok(Failure(reason)), there is no pending JSAPI exception.

impl FromJSValConvertible for RootedTraceableBox<TestDictionaryDefaults>

type Config = ()

Optional configurable behaviour switch; use () for no configuration.

unsafe fn from_jsval(
    cx: *mut JSContext,
    value: HandleValue<'_>,
    _option: ()
) -> Result<ConversionResult<RootedTraceableBox<TestDictionaryDefaults>>, ()>

Convert val to type Self. Optional configuration of type T can be passed as the option argument. If it returns Err(()), a JSAPI exception is pending. If it returns Ok(Failure(reason)), there is no pending JSAPI exception.

impl FromJSValConvertible for RootedTraceableBox<WindowPostMessageOptions>

type Config = ()

Optional configurable behaviour switch; use () for no configuration.

unsafe fn from_jsval(
    cx: *mut JSContext,
    value: HandleValue<'_>,
    _option: ()
) -> Result<ConversionResult<RootedTraceableBox<WindowPostMessageOptions>>, ()>

Convert val to type Self. Optional configuration of type T can be passed as the option argument. If it returns Err(()), a JSAPI exception is pending. If it returns Ok(Failure(reason)), there is no pending JSAPI exception.

impl FromJSValConvertible for RootedTraceableBox<XRSessionInit>

type Config = ()

Optional configurable behaviour switch; use () for no configuration.

unsafe fn from_jsval(
    cx: *mut JSContext,
    value: HandleValue<'_>,
    _option: ()
) -> Result<ConversionResult<RootedTraceableBox<XRSessionInit>>, ()>

Convert val to type Self. Optional configuration of type T can be passed as the option argument. If it returns Err(()), a JSAPI exception is pending. If it returns Ok(Failure(reason)), there is no pending JSAPI exception.

impl<T: JSTraceable + 'static> JSTraceable for RootedTraceableBox<T>

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

Trace self.

impl<T: JSTraceable + MallocSizeOf> MallocSizeOf for RootedTraceableBox<T>

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<T: ToJSValConvertible + JSTraceable> ToJSValConvertible for RootedTraceableBox<T>

unsafe fn to_jsval(&self, cx: *mut JSContext, rval: MutableHandleValue<'_>)

Convert self to a JSVal. JSAPI failure causes a panic.