Type Alias DomRoot

pub type DomRoot<T> = Root<Dom<T>>;

A rooted reference to a DOM object.

Aliased Type

struct DomRoot<T> {
    value: Dom<T>,
    root_list: *const RootCollection,
}

Fields

value: Dom<T>

The value to root.

root_list: *const RootCollection

List that ensures correct dynamic root ordering

Implementations

impl<T: Castable> DomRoot<T>

pub fn upcast<U>(root: DomRoot<T>) -> DomRoot<U>

where U: Castable, T: DerivedFrom<U>,

Cast a DOM object root upwards to one of the interfaces it derives from.

pub fn downcast<U>(root: DomRoot<T>) -> Option<DomRoot<U>>

where U: DerivedFrom<T>,

Cast a DOM object root downwards to one of the interfaces it might implement.

impl<T: DomObject> DomRoot<T>

pub fn from_ref(unrooted: &T) -> DomRoot<T>

Generate a new root from a reference

pub fn as_traced(&self) -> Dom<T>

Create a traced version of this rooted object.

Safety

This should never be used to create on-stack values. Instead these values should always end up as members of other DOM objects.

impl<T> Root<T>

where T: StableTraceObject + 'static,

pub unsafe fn new(value: T) -> Self

Create a new stack-bounded root for the provided value. It gives out references which cannot outlive this new Root.

Safety

It must not outlive its associated RootCollection.

Trait Implementations

impl<T> Clone for DomRoot<T>

where T: DomObject,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: DomObject + IDLInterface> FromJSValConvertible for DomRoot<T>

type Config = ()

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

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

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: DomObject> Hash for DomRoot<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> MallocSizeOf for DomRoot<T>

where T: DomObject + MallocSizeOf,

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> PartialEq for DomRoot<T>

where T: DomObject,

fn eq(&self, other: &Self) -> 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: DomObject> ToJSValConvertible for DomRoot<T>

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

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

impl<T> Traceable for DomRoot<T>

where T: DomObject,

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

Trace self.

impl<T: DomObject> Eq for DomRoot<T>

impl<T: Debug + StableTraceObject> Debug for Root<T>

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

Formats the value using the given formatter.

impl<T> Deref for Root<T>

where T: Deref + StableTraceObject,

type Target = <T as Deref>::Target

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> Drop for Root<T>

where T: StableTraceObject,

fn drop(&mut self)

Executes the destructor for this type.