Enum ScriptThreadMessage

pub enum ScriptThreadMessage {
    StopDelayingLoadEventsMode(PipelineId),
    AttachLayout(NewLayoutInfo),
    Resize(PipelineId, ViewportDetails, WindowSizeType),
    ThemeChange(PipelineId, Theme),
    ResizeInactive(PipelineId, ViewportDetails),
    ExitFullScreen(PipelineId),
    UnloadDocument(PipelineId),
    ExitPipeline(WebViewId, PipelineId, DiscardBrowsingContext),
    ExitScriptThread,
    SendInputEvent(PipelineId, ConstellationInputEvent),
    RefreshCursor(PipelineId),
    Viewport(PipelineId, Rect<f32, UnknownUnit>),
    GetTitle(PipelineId),
    SetDocumentActivity(PipelineId, DocumentActivity),
    SetThrottled(PipelineId, bool),
    SetThrottledInContainingIframe(PipelineId, BrowsingContextId, bool),
    NavigateIframe(PipelineId, BrowsingContextId, LoadData, NavigationHistoryBehavior),
    PostMessage {
        target: PipelineId,
        source: PipelineId,
        source_browsing_context: WebViewId,
        target_origin: Option<ImmutableOrigin>,
        source_origin: ImmutableOrigin,
        data: Box<StructuredSerializedData>,
    },
    UpdatePipelineId(PipelineId, BrowsingContextId, WebViewId, PipelineId, UpdatePipelineIdReason),
    UpdateHistoryState(PipelineId, Option<HistoryStateId>, ServoUrl),
    RemoveHistoryStates(PipelineId, Vec<HistoryStateId>),
    FocusIFrame(PipelineId, BrowsingContextId, FocusSequenceNumber),
    FocusDocument(PipelineId, FocusSequenceNumber),
    Unfocus(PipelineId, FocusSequenceNumber),
    WebDriverScriptCommand(PipelineId, WebDriverScriptCommand),
    TickAllAnimations(Vec<WebViewId>),
    WebFontLoaded(PipelineId, bool),
    DispatchIFrameLoadEvent {
        target: BrowsingContextId,
        parent: PipelineId,
        child: PipelineId,
    },
    DispatchStorageEvent(PipelineId, StorageType, ServoUrl, Option<String>, Option<String>, Option<String>),
    ReportCSSError(PipelineId, String, u32, u32, String),
    Reload(PipelineId),
    PaintMetric(PipelineId, ProgressiveWebMetricType, CrossProcessInstant, bool),
    MediaSessionAction(PipelineId, MediaSessionActionType),
    SetWebGPUPort(IpcReceiver<WebGPUMsg>),
    SetScrollStates(PipelineId, FxHashMap<ExternalScrollId, LayoutVector2D>),
    EvaluateJavaScript(PipelineId, JavaScriptEvaluationId, String),
    SendImageKeysBatch(PipelineId, Vec<ImageKey>),
    PreferencesUpdated(Vec<(String, PrefValue)>),
    NoLongerWaitingOnAsychronousImageUpdates(PipelineId),
}

Messages sent to the ScriptThread event loop from the Constellation, Compositor, and (for now) Layout.

Variants

StopDelayingLoadEventsMode(PipelineId)

Takes the associated window proxy out of “delaying-load-events-mode”, used if a scheduled navigated was refused by the embedder. https://html.spec.whatwg.org/multipage/#delaying-load-events-mode

AttachLayout(NewLayoutInfo)

Gives a channel and ID to a layout, as well as the ID of that layout’s parent

Resize(PipelineId, ViewportDetails, WindowSizeType)

Window resized. Sends a DOM event eventually, but first we combine events.

ThemeChange(PipelineId, Theme)

Theme changed.

ResizeInactive(PipelineId, ViewportDetails)

Notifies script that window has been resized but to not take immediate action.

ExitFullScreen(PipelineId)

Window switched from fullscreen mode.

UnloadDocument(PipelineId)

Notifies the script that the document associated with this pipeline should ‘unload’.

ExitPipeline(WebViewId, PipelineId, DiscardBrowsingContext)

Notifies the script that a pipeline should be closed.

ExitScriptThread

Notifies the script that the whole thread should be closed.

SendInputEvent(PipelineId, ConstellationInputEvent)

Sends a DOM event.

RefreshCursor(PipelineId)

Request that the given pipeline refresh the cursor by doing a hit test at the most recently hovered cursor position and resetting the cursor. This happens after a display list update is rendered.

Viewport(PipelineId, Rect<f32, UnknownUnit>)

Notifies script of the viewport.

GetTitle(PipelineId)

Requests that the script thread immediately send the constellation the title of a pipeline.

SetDocumentActivity(PipelineId, DocumentActivity)

Notifies script thread of a change to one of its document’s activity

SetThrottled(PipelineId, bool)

Set whether to use less resources by running timers at a heavily limited rate.

SetThrottledInContainingIframe(PipelineId, BrowsingContextId, bool)

Notify the containing iframe (in PipelineId) that the nested browsing context (BrowsingContextId) is throttled.

NavigateIframe(PipelineId, BrowsingContextId, LoadData, NavigationHistoryBehavior)

Notifies script thread that a url should be loaded in this iframe. PipelineId is for the parent, BrowsingContextId is for the nested browsing context

PostMessage

Post a message to a given window.

Fields

target: PipelineId

The target of the message.

source: PipelineId

The source of the message.

source_browsing_context: WebViewId

The top level browsing context associated with the source pipeline.

target_origin: Option<ImmutableOrigin>

The expected origin of the target.

source_origin: ImmutableOrigin

The source origin of the message. https://html.spec.whatwg.org/multipage/#dom-messageevent-origin

data: Box<StructuredSerializedData>

The data to be posted.

UpdatePipelineId(PipelineId, BrowsingContextId, WebViewId, PipelineId, UpdatePipelineIdReason)

Updates the current pipeline ID of a given iframe. First PipelineId is for the parent, second is the new PipelineId for the frame.

UpdateHistoryState(PipelineId, Option<HistoryStateId>, ServoUrl)

Updates the history state and url of a given pipeline.

RemoveHistoryStates(PipelineId, Vec<HistoryStateId>)

Removes inaccesible history states.

FocusIFrame(PipelineId, BrowsingContextId, FocusSequenceNumber)

Set an iframe to be focused. Used when an element in an iframe gains focus. PipelineId is for the parent, BrowsingContextId is for the nested browsing context

FocusDocument(PipelineId, FocusSequenceNumber)

Focus the document. Used when the container gains focus.

Unfocus(PipelineId, FocusSequenceNumber)

Notifies that the document’s container (e.g., an iframe) is not included in the top-level browsing context’s focus chain (not considering system focus) anymore.

Obviously, this message is invalid for a top-level document.

WebDriverScriptCommand(PipelineId, WebDriverScriptCommand)

Passes a webdriver command to the script thread for execution

TickAllAnimations(Vec<WebViewId>)

Notifies script thread that all animations are done

WebFontLoaded(PipelineId, bool)

Notifies the script thread that a new Web font has been loaded, and thus the page should be reflowed.

DispatchIFrameLoadEvent

Cause a load event to be dispatched at the appropriate iframe element.

Fields

target: BrowsingContextId

The frame that has been marked as loaded.

parent: PipelineId

The pipeline that contains a frame loading the target pipeline.

child: PipelineId

The pipeline that has completed loading.

DispatchStorageEvent(PipelineId, StorageType, ServoUrl, Option<String>, Option<String>, Option<String>)

Cause a storage event to be dispatched at the appropriate window. The strings are key, old value and new value.

ReportCSSError(PipelineId, String, u32, u32, String)

Report an error from a CSS parser for the given pipeline

Reload(PipelineId)

Reload the given page.

PaintMetric(PipelineId, ProgressiveWebMetricType, CrossProcessInstant, bool)

Notifies the script thread about a new recorded paint metric.

MediaSessionAction(PipelineId, MediaSessionActionType)

Notifies the media session about a user requested media session action.

SetWebGPUPort(IpcReceiver<WebGPUMsg>)

Notifies script thread that WebGPU server has started

SetScrollStates(PipelineId, FxHashMap<ExternalScrollId, LayoutVector2D>)

The compositor scrolled and is updating the scroll states of the nodes in the given pipeline via the Constellation.

EvaluateJavaScript(PipelineId, JavaScriptEvaluationId, String)

Evaluate the given JavaScript and return a result via a corresponding message to the Constellation.

SendImageKeysBatch(PipelineId, Vec<ImageKey>)

A new batch of keys for the image cache for the specific pipeline.

PreferencesUpdated(Vec<(String, PrefValue)>)

Preferences were updated in the parent process.

NoLongerWaitingOnAsychronousImageUpdates(PipelineId)

Notify the ScriptThread that the Servo renderer is no longer waiting on asynchronous image uploads for the given Pipeline. These are mainly used by canvas to perform uploads while the display list is being built.

Trait Implementations

impl Debug for ScriptThreadMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScriptThreadMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'_derivative_strum> From<&'_derivative_strum ScriptThreadMessage> for &'static str

fn from(x: &'_derivative_strum ScriptThreadMessage) -> &'static str

Converts to this type from the input type.

impl From<ScriptThreadMessage> for &'static str

fn from(x: ScriptThreadMessage) -> &'static str

Converts to this type from the input type.

impl Serialize for ScriptThreadMessage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.