Struct Root

pub struct Root<T: StableTraceObject> {
    value: T,
    root_list: *const RootCollection,
}

A rooted value.

Fields

value: T

The value to root.

root_list: *const RootCollection

List that ensures correct dynamic root ordering

Implementations

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.

impl<T> Root<MaybeUnreflectedDom<T>>

where T: DomObject,

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

impl<T> Root<MaybeUnreflectedDom<T>>

where T: MutDomObject,

pub unsafe fn reflect_with(self, obj: *mut JSObject) -> DomRoot<T>

Treat the given JS object as the reflector of this unreflected object.

Safety

obj must point to a valid, non-null JS object.

impl<T: Castable> Root<Dom<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> Root<Dom<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.

Trait Implementations

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.