Struct script::document_collection::DocumentCollection

pub(crate) struct DocumentCollection {
    map: HashMapTracedValues<PipelineId, Dom<Document>>,
}

The collection of all Documents managed by the [crate::script_thread::SriptThread]. This is stored as a mapping of PipelineId to Document, but for updating the rendering, Documents should be processed in order via Self::documents_in_order.

Fields

map: HashMapTracedValues<PipelineId, Dom<Document>>

Implementations

impl DocumentCollection

pub fn insert(&mut self, pipeline_id: PipelineId, doc: &Document)

pub fn remove(&mut self, pipeline_id: PipelineId) -> Option<Root<Dom<Document>>>

pub fn find_document( &self, pipeline_id: PipelineId, ) -> Option<Root<Dom<Document>>>

pub fn find_window(&self, pipeline_id: PipelineId) -> Option<Root<Dom<Window>>>

pub fn find_global( &self, pipeline_id: PipelineId, ) -> Option<Root<Dom<GlobalScope>>>

pub fn find_iframe( &self, pipeline_id: PipelineId, browsing_context_id: BrowsingContextId, ) -> Option<Root<Dom<HTMLIFrameElement>>>

pub fn iter(&self) -> DocumentsIter<'_>

pub(crate) fn documents_in_order(&self) -> Vec<PipelineId>

Return the documents managed by this crate::script_thread::ScriptThread in the order specified by the update the rendering step of the HTML specification:

Let docs be all fully active Document objects whose relevant agent’s event loop is eventLoop, sorted arbitrarily except that the following conditions must be met:

Any Document B whose container document is A must be listed after A in the list.

If there are two documents A and B that both have the same non-null container document C, then the order of A and B in the list must match the shadow-including tree order of their respective navigable containers in C’s node tree.

In the steps below that iterate over docs, each Document must be processed in the order it is found in the list.

Trait Implementations

impl Default for DocumentCollection

fn default() -> Self

Returns the “default value” for a type.

impl Traceable for DocumentCollection

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

Trace self.