Struct script::dom::bindings::root::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 cannot outlive its associated RootCollection, and it gives out references which cannot outlive this new Root.

impl<T: Castable> Root<Dom<T>>

pub fn upcast<U>(root: Root<Dom<T>>) -> Root<Dom<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: Root<Dom<T>>) -> Option<Root<Dom<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) -> Root<Dom<T>>

Generate a new root from a reference

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) -> Root<Dom<T>>

Trait Implementations

impl<T> Clone for Root<Dom<T>>where
    T: DomObject,

fn clone(&self) -> Root<Dom<T>>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Root<Dom<Element>>

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.

impl<'a> Element for Root<Dom<Element>>

type Impl = SelectorImpl

fn opaque(&self) -> OpaqueElement

Converts self into an opaque representation.

fn parent_element(&self) -> Option<Root<Dom<Element>>>

fn parent_node_is_shadow_root(&self) -> bool

Whether the parent node of this element is a shadow root.

fn containing_shadow_host(&self) -> Option<Self>

The host of the containing shadow root, if any.

fn is_pseudo_element(&self) -> bool

Whether we’re matching on a pseudo-element.

fn match_pseudo_element(
    &self,
    _pseudo: &PseudoElement,
    _context: &mut MatchingContext<'_, Self::Impl>
) -> bool

fn prev_sibling_element(&self) -> Option<Root<Dom<Element>>>

Skips non-element nodes

fn next_sibling_element(&self) -> Option<Root<Dom<Element>>>

Skips non-element nodes

fn attr_matches(
    &self,
    ns: &NamespaceConstraint<&Namespace>,
    local_name: &LocalName,
    operation: &AttrSelectorOperation<&AtomString>
) -> bool

fn is_root(&self) -> bool

Returns whether this element matches :root, i.e. whether it is the root element of a document.

fn is_empty(&self) -> bool

Returns whether this element matches :empty.

fn has_local_name(&self, local_name: &LocalName) -> bool

fn has_namespace(&self, ns: &Namespace) -> bool

Empty string for no namespace

fn is_same_type(&self, other: &Self) -> bool

Whether this element and the other element have the same local name and namespace.

fn match_non_ts_pseudo_class<F>(
    &self,
    pseudo_class: &NonTSPseudoClass,
    _: &mut MatchingContext<'_, Self::Impl>,
    _: &mut F
) -> boolwhere
    F: FnMut(&Self, ElementSelectorFlags),

fn is_link(&self) -> bool

Whether this element is a link.

fn has_id(&self, id: &AtomIdent, case_sensitivity: CaseSensitivity) -> bool

fn is_part(&self, _name: &AtomIdent) -> bool

fn imported_part(&self, _: &AtomIdent) -> Option<AtomIdent>

Returns the mapping from the exportparts attribute in the reverse direction, that is, in an outer-tree -> inner-tree direction.

fn has_class(&self, name: &AtomIdent, case_sensitivity: CaseSensitivity) -> bool

fn is_html_element_in_html_document(&self) -> bool

fn is_html_slot_element(&self) -> bool

Returns whether the element is an HTML element.

fn pseudo_element_originating_element(&self) -> Option<Self>

The parent of a given pseudo-element, after matching a pseudo-element selector.

fn assigned_slot(&self) -> Option<Self>

Returns the assigned element this element is assigned to.

fn ignores_nth_child_selectors(&self) -> bool

Returns whether this element should ignore matching nth child selector.

impl<T: DomObject + IDLInterface> FromJSValConvertible for Root<Dom<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<Root<Dom<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 Hash for Root<Dom<GPUBuffer>>

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> JSTraceable for Root<Dom<T>>where
    T: DomObject,

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

Trace self.

impl<T> MallocSizeOf for Root<Dom<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<Root<Dom<T>>> for Root<Dom<T>>where
    T: DomObject,

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T: DomObject> ToJSValConvertible for Root<Dom<T>>

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

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

impl Eq for Root<Dom<GPUBuffer>>