Struct script::dom::globalscope::GlobalScope

#[repr(C)]
pub struct GlobalScope {

    eventtarget: EventTarget,
    crypto: MutNullableDom<Crypto>,
    message_port_state: DomRefCell<MessagePortState>,
    broadcast_channel_state: DomRefCell<BroadcastChannelState>,
    blob_state: DomRefCell<BlobState>,
    registration_map: DomRefCell<HashMapTracedValues<ServiceWorkerRegistrationId, Dom<ServiceWorkerRegistration>>>,
    worker_map: DomRefCell<HashMapTracedValues<ServiceWorkerId, Dom<ServiceWorker>>>,
    pipeline_id: PipelineId,
    devtools_wants_updates: Cell<bool>,
    console_timers: DomRefCell<HashMap<DOMString, Instant>>,
    module_map: DomRefCell<HashMapTracedValues<ServoUrl, Rc<ModuleTree>>>,
    inline_module_map: DomRefCell<HashMap<ScriptId, Rc<ModuleTree>>>,
    devtools_chan: Option<IpcSender<ScriptToDevtoolsControlMsg>>,
    mem_profiler_chan: ProfilerChan,
    time_profiler_chan: ProfilerChan,
    script_to_constellation_chan: ScriptToConstellationChan,
    scheduler_chan: IpcSender<TimerSchedulerMsg>,
    in_error_reporting_mode: Cell<bool>,
    resource_threads: ResourceThreads,
    timers: OneshotTimers,
    init_timers: Cell<bool>,
    origin: MutableOrigin,
    creation_url: Option<ServoUrl>,
    permission_state_invocation_results: DomRefCell<HashMap<String, PermissionState>>,
    microtask_queue: Rc<MicrotaskQueue>,
    list_auto_close_worker: DomRefCell<Vec<AutoCloseWorker>>,
    event_source_tracker: DOMTracker<EventSource>,
    uncaught_rejections: DomRefCell<Vec<Box<Heap<*mut JSObject>>>>,
    consumed_rejections: DomRefCell<Vec<Box<Heap<*mut JSObject>>>>,
    is_headless: bool,
    user_agent: Cow<'static, str>,
    gpu_id_hub: Arc<IdentityHub>,
    gpu_devices: DomRefCell<HashMapTracedValues<WebGPUDevice, WeakRef<GPUDevice>>>,
    frozen_supported_performance_entry_types: CachedFrozenArray,
    https_state: Cell<HttpsState>,
    console_group_stack: DomRefCell<Vec<DOMString>>,
    console_count_map: DomRefCell<HashMap<DOMString, usize>>,
    dynamic_modules: DomRefCell<DynamicModuleList>,
    inherited_secure_context: Option<bool>,
    unminified_js_dir: Option<String>,
    byte_length_queuing_strategy_size_function: OnceCell<Rc<Function>>,
    count_queuing_strategy_size_function: OnceCell<Rc<Function>>,
}

Fields

eventtarget: EventTarget

crypto: MutNullableDom<Crypto>

message_port_state: DomRefCell<MessagePortState>

The message-port router id for this global, if it is managing ports.

broadcast_channel_state: DomRefCell<BroadcastChannelState>

The broadcast channels state this global, if it is managing any.

blob_state: DomRefCell<BlobState>

The blobs managed by this global, if any.

registration_map: DomRefCell<HashMapTracedValues<ServiceWorkerRegistrationId, Dom<ServiceWorkerRegistration>>>

https://w3c.github.io/ServiceWorker/#environment-settings-object-service-worker-registration-object-map

worker_map: DomRefCell<HashMapTracedValues<ServiceWorkerId, Dom<ServiceWorker>>>

https://w3c.github.io/ServiceWorker/#environment-settings-object-service-worker-object-map

pipeline_id: PipelineId

Pipeline id associated with this global.

devtools_wants_updates: Cell<bool>

A flag to indicate whether the developer tools has requested live updates from the worker.

console_timers: DomRefCell<HashMap<DOMString, Instant>>

Timers (milliseconds) used by the Console API.

module_map: DomRefCell<HashMapTracedValues<ServoUrl, Rc<ModuleTree>>>

module map is used when importing JavaScript modules https://html.spec.whatwg.org/multipage/#concept-settings-object-module-map

inline_module_map: DomRefCell<HashMap<ScriptId, Rc<ModuleTree>>>

devtools_chan: Option<IpcSender<ScriptToDevtoolsControlMsg>>

For providing instructions to an optional devtools server.

mem_profiler_chan: ProfilerChan

For sending messages to the memory profiler.

time_profiler_chan: ProfilerChan

For sending messages to the time profiler.

script_to_constellation_chan: ScriptToConstellationChan

A handle for communicating messages to the constellation thread.

scheduler_chan: IpcSender<TimerSchedulerMsg>

in_error_reporting_mode: Cell<bool>

https://html.spec.whatwg.org/multipage/#in-error-reporting-mode

resource_threads: ResourceThreads

Associated resource threads for use by DOM objects like XMLHttpRequest, including resource_thread, filemanager_thread and storage_thread

timers: OneshotTimers

The mechanism by which time-outs and intervals are scheduled. https://html.spec.whatwg.org/multipage/#timers

init_timers: Cell<bool>

Have timers been initialized?

origin: MutableOrigin

The origin of the globalscope

creation_url: Option<ServoUrl>

https://html.spec.whatwg.org/multipage/#concept-environment-creation-url

permission_state_invocation_results: DomRefCell<HashMap<String, PermissionState>>

A map for storing the previous permission state read results.

microtask_queue: Rc<MicrotaskQueue>

The microtask queue associated with this global.

It is refcounted because windows in the same script thread share the same microtask queue.

https://html.spec.whatwg.org/multipage/#microtask-queue

list_auto_close_worker: DomRefCell<Vec<AutoCloseWorker>>

Vector storing closing references of all workers

event_source_tracker: DOMTracker<EventSource>

Vector storing references of all eventsources.

uncaught_rejections: DomRefCell<Vec<Box<Heap<*mut JSObject>>>>

Storage for watching rejected promises waiting for some client to consume their rejection. Promises in this list have been rejected in the last turn of the event loop without the rejection being handled. Note that this can contain nullptrs in place of promises removed because they’re consumed before it’d be reported.

https://html.spec.whatwg.org/multipage/#about-to-be-notified-rejected-promises-list

consumed_rejections: DomRefCell<Vec<Box<Heap<*mut JSObject>>>>

Promises in this list have previously been reported as rejected (because they were in the above list), but the rejection was handled in the last turn of the event loop.

https://html.spec.whatwg.org/multipage/#outstanding-rejected-promises-weak-set

is_headless: bool

True if headless mode.

user_agent: Cow<'static, str>

An optional string allowing the user agent to be set for testing.

gpu_id_hub: Arc<IdentityHub>

Identity Manager for WebGPU resources

gpu_devices: DomRefCell<HashMapTracedValues<WebGPUDevice, WeakRef<GPUDevice>>>

WebGPU devices

frozen_supported_performance_entry_types: CachedFrozenArray

https_state: Cell<HttpsState>

currect https state (from previous request)

console_group_stack: DomRefCell<Vec<DOMString>>

The stack of active group labels for the Console APIs.

console_count_map: DomRefCell<HashMap<DOMString, usize>>

The count map for the Console APIs.

https://console.spec.whatwg.org/#count

dynamic_modules: DomRefCell<DynamicModuleList>

List of ongoing dynamic module imports.

inherited_secure_context: Option<bool>

Is considered in a secure context

unminified_js_dir: Option<String>

Directory to store unminified scripts for this window if unminify-js opt is enabled.

byte_length_queuing_strategy_size_function: OnceCell<Rc<Function>>

The byte length queuing strategy size function that will be initialized once size getter of ByteLengthQueuingStrategy is called.

https://streams.spec.whatwg.org/#byte-length-queuing-strategy-size-function

count_queuing_strategy_size_function: OnceCell<Rc<Function>>

The count queuing strategy size function that will be initialized once size getter of CountQueuingStrategy is called.

https://streams.spec.whatwg.org/#count-queuing-strategy-size-function

Implementations

impl GlobalScope

pub fn new_inherited( pipeline_id: PipelineId, devtools_chan: Option<IpcSender<ScriptToDevtoolsControlMsg>>, mem_profiler_chan: ProfilerChan, time_profiler_chan: ProfilerChan, script_to_constellation_chan: ScriptToConstellationChan, scheduler_chan: IpcSender<TimerSchedulerMsg>, resource_threads: ResourceThreads, origin: MutableOrigin, creation_url: Option<ServoUrl>, microtask_queue: Rc<MicrotaskQueue>, is_headless: bool, user_agent: Cow<'static, str>, gpu_id_hub: Arc<IdentityHub>, inherited_secure_context: Option<bool>, unminify_js: bool, ) -> Self

fn port_router_id(&self) -> Option<MessagePortRouterId>

The message-port router Id of the global, if any

fn is_managing_port(&self, port_id: &MessagePortId) -> bool

Is this global managing a given port?

fn setup_timers(&self)

Setup the IPC-to-event-loop glue for timers to schedule themselves.

pub fn get_serviceworker_registration( &self, script_url: &ServoUrl, scope: &ServoUrl, registration_id: ServiceWorkerRegistrationId, installing_worker: Option<ServiceWorkerId>, _waiting_worker: Option<ServiceWorkerId>, _active_worker: Option<ServiceWorkerId>, ) -> Root<Dom<ServiceWorkerRegistration>>

https://w3c.github.io/ServiceWorker/#get-the-service-worker-registration-object

pub fn get_serviceworker( &self, script_url: &ServoUrl, scope: &ServoUrl, worker_id: ServiceWorkerId, ) -> Root<Dom<ServiceWorker>>

https://w3c.github.io/ServiceWorker/#get-the-service-worker-object

fn complete_port_transfer( &self, port_id: MessagePortId, tasks: VecDeque<PortMessageTask>, )

Complete the transfer of a message-port.

pub fn perform_a_dom_garbage_collection_checkpoint(&self)

Clean-up DOM related resources

pub fn remove_web_messaging_and_dedicated_workers_infra(&self)

Remove the routers for ports and broadcast-channels. Drain the list of workers.

fn remove_message_ports_router(&self)

Update our state to un-managed, and tell the constellation to drop the sender to our message-port router.

fn remove_broadcast_channel_router(&self)

Update our state to un-managed, and tell the constellation to drop the sender to our broadcast router.

pub fn entangle_ports(&self, port1: MessagePortId, port2: MessagePortId)

https://html.spec.whatwg.org/multipage/#entangle

pub fn note_entangled_port_removed(&self, port_id: &MessagePortId)

Note that the entangled port of port_id has been removed in another global.

pub fn mark_port_as_transferred( &self, port_id: &MessagePortId, ) -> MessagePortImpl

Handle the transfer of a port in the current task.

pub fn start_message_port(&self, port_id: &MessagePortId)

https://html.spec.whatwg.org/multipage/#dom-messageport-start

pub fn close_message_port(&self, port_id: &MessagePortId)

https://html.spec.whatwg.org/multipage/#dom-messageport-close

pub fn post_messageport_msg( &self, port_id: MessagePortId, task: PortMessageTask, )

https://html.spec.whatwg.org/multipage/#message-port-post-message-steps

fn re_route_port_task(&self, port_id: MessagePortId, task: PortMessageTask)

If we don’t know about the port, send the message to the constellation for routing.

pub fn schedule_broadcast(&self, msg: BroadcastMsg, channel_id: &Uuid)

https://html.spec.whatwg.org/multipage/#dom-broadcastchannel-postmessage Step 7 and following steps.

pub fn broadcast_message_event( &self, event: BroadcastMsg, channel_id: Option<&Uuid>, )

https://html.spec.whatwg.org/multipage/#dom-broadcastchannel-postmessage Step 7 and following steps.

pub fn route_task_to_port( &self, port_id: MessagePortId, task: PortMessageTask, can_gc: CanGc, )

Route the task to be handled by the relevant port.

pub fn maybe_add_pending_ports(&self)

Check all ports that have been transfer-received in the previous task, and complete their transfer if they haven’t been re-transferred.

pub fn perform_a_message_port_garbage_collection_checkpoint(&self)

https://html.spec.whatwg.org/multipage/#ports-and-garbage-collection

pub fn perform_a_broadcast_channel_garbage_collection_checkpoint(&self)

Remove broadcast-channels that are closed. TODO: Also remove them if they do not have an event-listener. see https://github.com/servo/servo/issues/25772

pub fn track_broadcast_channel(&self, dom_channel: &BroadcastChannel)

Start tracking a broadcast-channel.

pub fn track_message_port( &self, dom_port: &MessagePort, port_impl: Option<MessagePortImpl>, )

Start tracking a message-port

pub fn serialize_blob(&self, blob_id: &BlobId) -> BlobImpl

https://html.spec.whatwg.org/multipage/#serialization-steps defined at https://w3c.github.io/FileAPI/#blob-section. Get the snapshot state and underlying bytes of the blob.

fn track_blob_info(&self, blob_info: BlobInfo, blob_id: BlobId)

pub fn track_blob(&self, dom_blob: &Blob, blob_impl: BlobImpl)

Start tracking a blob

pub fn track_file(&self, file: &File, blob_impl: BlobImpl)

Start tracking a file

fn perform_a_blob_garbage_collection_checkpoint(&self)

Clean-up any file or blob that is unreachable from script, unless it has an oustanding blob url. https://w3c.github.io/FileAPI/#lifeTime

pub fn clean_up_all_file_resources(&self)

Clean-up all file related resources on document unload. https://w3c.github.io/FileAPI/#lifeTime

fn decrement_file_ref(&self, id: Uuid)

pub fn get_blob_bytes(&self, blob_id: &BlobId) -> Result<Vec<u8>, ()>

Get a slice to the inner data of a Blob, In the case of a File-backed blob, this might incur synchronous read and caching.

fn get_blob_bytes_non_sliced(&self, blob_id: &BlobId) -> Result<Vec<u8>, ()>

Get bytes from a non-sliced blob

fn get_blob_bytes_or_file_id(&self, blob_id: &BlobId) -> BlobResult

Get a slice to the inner data of a Blob, if it’s a memory blob, or it’s file-id and file-size otherwise.

Note: this is almost a duplicate of get_blob_bytes, tweaked for integration with streams. TODO: merge with get_blob_bytes by way of broader integration with blob streams.

fn get_blob_bytes_non_sliced_or_file_id(&self, blob_id: &BlobId) -> BlobResult

Get bytes from a non-sliced blob if in memory, or it’s file-id and file-size.

Note: this is almost a duplicate of get_blob_bytes_non_sliced, tweaked for integration with streams. TODO: merge with get_blob_bytes by way of broader integration with blob streams.

pub fn get_blob_type_string(&self, blob_id: &BlobId) -> String

Get a copy of the type_string of a blob.

pub fn get_blob_size(&self, blob_id: &BlobId) -> u64

https://w3c.github.io/FileAPI/#dfn-size

pub fn get_blob_url_id(&self, blob_id: &BlobId) -> Uuid

fn create_sliced_url_id( &self, blob_info: &mut BlobInfo, parent_file_id: &Uuid, rel_pos: &RelativePos, parent_len: u64, ) -> Uuid

Get a FileID representing sliced parent-blob content

pub fn promote(&self, blob_info: &mut BlobInfo, set_valid: bool) -> Uuid

Promote non-Slice blob:

1. Memory-based: The bytes in data slice will be transferred to file manager thread.
2. File-based: If set_valid, then activate the FileID so it can serve as URL Depending on set_valid, the returned FileID can be part of valid or invalid Blob URL.

fn send_to_file_manager(&self, msg: FileManagerThreadMsg)

fn read_file(&self, id: Uuid) -> Result<Vec<u8>, ()>

pub fn get_blob_stream( &self, blob_id: &BlobId, can_gc: CanGc, ) -> Root<Dom<ReadableStream>>

https://w3c.github.io/FileAPI/#blob-get-stream

pub fn read_file_async( &self, id: Uuid, promise: Rc<Promise>, callback: Box<dyn Fn(Rc<Promise>, Result<Vec<u8>, Error>) + Send>, )

fn send_msg(&self, id: Uuid) -> IpcReceiver<FileManagerResult<ReadFileProgress>>

fn read_msg( receiver: IpcReceiver<FileManagerResult<ReadFileProgress>>, ) -> Result<Vec<u8>, ()>

pub fn permission_state_invocation_results( &self, ) -> &DomRefCell<HashMap<String, PermissionState>>

pub fn track_worker( &self, closing: Arc<AtomicBool>, join_handle: JoinHandle<()>, control_sender: Sender<DedicatedWorkerControlMsg>, context: ThreadSafeJSContext, )

pub fn track_event_source(&self, event_source: &EventSource)

pub fn close_event_sources(&self) -> bool

pub fn from_reflector<T: DomObject>( reflector: &T, _realm: &AlreadyInRealm, ) -> Root<Dom<Self>>

Returns the global scope of the realm that the given DOM object’s reflector was created in.

pub unsafe fn from_object(obj: *mut JSObject) -> Root<Dom<Self>>

Returns the global scope of the realm that the given JS object was created in.

pub unsafe fn from_context( cx: *mut JSContext, _realm: InRealm<'_>, ) -> Root<Dom<Self>>

Returns the global scope for the given JSContext

pub fn from_safe_context( cx: SafeJSContext, realm: InRealm<'_>, ) -> Root<Dom<Self>>

Returns the global scope for the given SafeJSContext

pub unsafe fn from_object_maybe_wrapped( obj: *mut JSObject, cx: *mut JSContext, ) -> Root<Dom<Self>>

Returns the global object of the realm that the given JS object was created in, after unwrapping any wrappers.

pub fn add_uncaught_rejection(&self, rejection: HandleObject)

pub fn remove_uncaught_rejection(&self, rejection: HandleObject)

pub fn get_uncaught_rejections( &self, ) -> &DomRefCell<Vec<Box<Heap<*mut JSObject>>>>

pub fn add_consumed_rejection(&self, rejection: HandleObject)

pub fn remove_consumed_rejection(&self, rejection: HandleObject)

pub fn get_consumed_rejections( &self, ) -> &DomRefCell<Vec<Box<Heap<*mut JSObject>>>>

pub fn set_module_map(&self, url: ServoUrl, module: ModuleTree)

pub fn get_module_map( &self, ) -> &DomRefCell<HashMapTracedValues<ServoUrl, Rc<ModuleTree>>>

pub fn set_inline_module_map(&self, script_id: ScriptId, module: ModuleTree)

pub fn get_inline_module_map( &self, ) -> &DomRefCell<HashMap<ScriptId, Rc<ModuleTree>>>

pub fn get_cx() -> SafeJSContext

pub fn crypto(&self) -> Root<Dom<Crypto>>

pub fn live_devtools_updates(&self) -> bool

pub fn set_devtools_wants_updates(&self, value: bool)

pub fn time(&self, label: DOMString) -> Result<(), ()>

pub fn time_log(&self, label: &str) -> Result<u64, ()>

Computes the delta time since a label has been created

Returns an error if the label does not exist.

pub fn time_end(&self, label: &str) -> Result<u64, ()>

Computes the delta time since a label has been created and stops tracking the label.

Returns an error if the label does not exist.

pub fn devtools_chan(&self) -> Option<&IpcSender<ScriptToDevtoolsControlMsg>>

Get an &IpcSender<ScriptToDevtoolsControlMsg> to send messages to the devtools thread when available.

pub fn issue_page_warning(&self, warning: &str)

pub fn mem_profiler_chan(&self) -> &ProfilerChan

Get a sender to the memory profiler thread.

pub fn time_profiler_chan(&self) -> &ProfilerChan

Get a sender to the time profiler thread.

pub fn script_to_constellation_chan(&self) -> &ScriptToConstellationChan

Get a sender to the constellation thread.

pub fn send_to_embedder(&self, msg: EmbedderMsg)

pub fn send_to_constellation(&self, msg: ScriptMsg)

pub fn scheduler_chan(&self) -> &IpcSender<TimerSchedulerMsg>

pub fn pipeline_id(&self) -> PipelineId

Get the PipelineId for this global scope.

pub fn origin(&self) -> &MutableOrigin

Get the origin for this global scope

pub fn creation_url(&self) -> &Option<ServoUrl>

Get the creation_url for this global scope

pub fn image_cache(&self) -> Arc<dyn ImageCache>

pub fn policy_container(&self) -> PolicyContainer

https://html.spec.whatwg.org/multipage/#concept-settings-object-policy-container

pub fn api_base_url(&self) -> ServoUrl

Get the base url for this global scope.

pub fn get_url(&self) -> ServoUrl

Get the URL for this global scope.

pub fn get_referrer_policy(&self) -> ReferrerPolicy

Get the Referrer Policy for this global scope.

pub fn get_referrer(&self) -> Referrer

Determine the Referrer for a request whose Referrer is “client”

pub fn as_window(&self) -> &Window

Extract a Window, panic if the global object is not a Window.

pub fn report_an_error( &self, error_info: ErrorInfo, value: HandleValue<'_>, can_gc: CanGc, )

https://html.spec.whatwg.org/multipage/#report-the-error

pub fn resource_threads(&self) -> &ResourceThreads

Get the &ResourceThreads for this global scope.

pub fn core_resource_thread(&self) -> CoreResourceThread

Get the CoreResourceThread for this global scope.

pub fn script_chan(&self) -> Box<dyn ScriptChan + Send>

ScriptChan to send messages to the event loop of this global scope.

pub fn gamepad_task_source(&self) -> GamepadTaskSource

TaskSource to send messages to the gamepad task source of this global scope. https://w3c.github.io/gamepad/#dfn-gamepad-task-source

pub fn networking_task_source(&self) -> NetworkingTaskSource

TaskSource to send messages to the networking task source of this global scope.

pub fn port_message_queue(&self) -> PortMessageQueue

TaskSource to send messages to the port message queue of this global scope.

pub fn timer_task_source(&self) -> TimerTaskSource

TaskSource to send messages to the timer queue of this global scope.

pub fn remote_event_task_source(&self) -> RemoteEventTaskSource

TaskSource to send messages to the remote-event task source of this global scope.

pub fn websocket_task_source(&self) -> WebsocketTaskSource

TaskSource to send messages to the websocket task source of this global scope.

pub fn evaluate_js_on_global_with_result( &self, code: &str, rval: MutableHandleValue<'_>, fetch_options: ScriptFetchOptions, script_base_url: ServoUrl, can_gc: CanGc, ) -> bool

Evaluate JS code on this global scope.

pub fn evaluate_script_on_global_with_result( &self, code: &SourceCode, filename: &str, rval: MutableHandleValue<'_>, line_number: u32, fetch_options: ScriptFetchOptions, script_base_url: ServoUrl, can_gc: CanGc, ) -> bool

Evaluate a JS script on this global scope.

pub fn schedule_callback( &self, callback: OneshotTimerCallback, duration: Duration, ) -> OneshotTimerHandle

https://html.spec.whatwg.org/multipage/#timer-initialisation-steps

pub fn unschedule_callback(&self, handle: OneshotTimerHandle)

pub fn set_timeout_or_interval( &self, callback: TimerCallback, arguments: Vec<HandleValue<'_>>, timeout: Duration, is_interval: IsInterval, ) -> i32

https://html.spec.whatwg.org/multipage/#timer-initialisation-steps

pub fn clear_timeout_or_interval(&self, handle: i32)

pub fn queue_function_as_microtask(&self, callback: Rc<VoidFunction>)

pub fn is_js_evaluation_allowed(&self, cx: SafeJSContext) -> bool

pub fn create_image_bitmap( &self, image: ImageBitmapSource, options: &ImageBitmapOptions, can_gc: CanGc, ) -> Rc<Promise>

pub fn fire_timer(&self, handle: TimerEventId, can_gc: CanGc)

pub fn resume(&self)

pub fn suspend(&self)

pub fn slow_down_timers(&self)

pub fn speed_up_timers(&self)

fn timer_source(&self) -> TimerSource

pub fn can_continue_running(&self) -> bool

Returns a boolean indicating whether the event-loop where this global is running on can continue running JS.

pub fn task_canceller(&self, name: TaskSourceName) -> TaskCanceller

Returns the task canceller of this global to ensure that everything is properly cancelled when the global scope is destroyed.

pub fn perform_a_microtask_checkpoint(&self, can_gc: CanGc)

Perform a microtask checkpoint.

pub fn enqueue_microtask(&self, job: Microtask)

Enqueue a microtask for subsequent execution.

pub fn new_script_pair( &self, ) -> (Box<dyn ScriptChan + Send>, Box<dyn ScriptPort + Send>)

Create a new sender/receiver pair that can be used to implement an on-demand event loop. Used for implementing web APIs that require blocking semantics without resorting to nested event loops.

pub fn microtask_queue(&self) -> &Rc<MicrotaskQueue>

Returns the microtask queue of this global.

pub fn process_event(&self, msg: CommonScriptMsg) -> bool

Process a single event as if it were the next event in the queue for the event-loop where this global scope is running on. Returns a boolean indicating whether further events should be processed.

pub fn dom_manipulation_task_source(&self) -> DOMManipulationTaskSource

pub fn file_reading_task_source(&self) -> FileReadingTaskSource

Channel to send messages to the file reading task source of this of this global scope.

pub fn runtime_handle(&self) -> ParentRuntime

pub fn current() -> Option<Root<Dom<Self>>>

Returns the “current” global object.

pub fn entry() -> Root<Dom<Self>>

Returns the “entry” global object.

pub fn incumbent() -> Option<Root<Dom<Self>>>

Returns the “incumbent” global object.

pub fn performance(&self) -> Root<Dom<Performance>>

pub fn performance_timeline_task_source(&self) -> PerformanceTimelineTaskSource

Channel to send messages to the performance timeline task source of this global scope.

pub fn supported_performance_entry_types( &self, cx: SafeJSContext, retval: MutableHandleValue<'_>, )

https://w3c.github.io/performance-timeline/#supportedentrytypes-attribute

pub fn is_headless(&self) -> bool

pub fn get_user_agent(&self) -> Cow<'static, str>

pub fn get_https_state(&self) -> HttpsState

pub fn set_https_state(&self, https_state: HttpsState)

pub fn is_secure_context(&self) -> bool

pub fn get_csp_list(&self) -> Option<CspList>

https://www.w3.org/TR/CSP/#get-csp-of-object

pub fn status_code(&self) -> Option<u16>

pub fn wgpu_id_hub(&self) -> Arc<IdentityHub>

pub fn add_gpu_device(&self, device: &GPUDevice)

pub fn remove_gpu_device(&self, device: WebGPUDevice)

pub fn gpu_device_lost( &self, device: WebGPUDevice, reason: DeviceLostReason, msg: String, )

pub fn handle_uncaptured_gpu_error( &self, device: WebGPUDevice, error: Error, can_gc: CanGc, )

pub fn handle_gamepad_event(&self, gamepad_event: GamepadEvent)

fn handle_gamepad_connect( &self, _index: usize, name: String, axis_bounds: (f64, f64), button_bounds: (f64, f64), supported_haptic_effects: GamepadSupportedHapticEffects, )

https://www.w3.org/TR/gamepad/#dfn-gamepadconnected

pub fn handle_gamepad_disconnect(&self, index: usize)

https://www.w3.org/TR/gamepad/#dfn-gamepaddisconnected

pub fn receive_new_gamepad_button_or_axis( &self, index: usize, update_type: GamepadUpdateType, )

https://www.w3.org/TR/gamepad/#receiving-inputs

pub(crate) fn current_group_label(&self) -> Option<DOMString>

pub(crate) fn push_console_group(&self, group: DOMString)

pub(crate) fn pop_console_group(&self)

pub(crate) fn increment_console_count(&self, label: &DOMString) -> usize

pub(crate) fn reset_console_count(&self, label: &DOMString) -> Result<(), ()>

pub(crate) fn dynamic_module_list(&self) -> RefMut<'_, DynamicModuleList>

pub(crate) fn structured_clone( &self, cx: SafeJSContext, value: HandleValue<'_>, options: RootedTraceableBox<StructuredSerializeOptions>, retval: MutableHandleValue<'_>, ) -> Result<(), Error>

pub(crate) fn fetch<Listener: FetchResponseListener + PreInvoke + Send + 'static>( &self, request_builder: RequestBuilder, context: Arc<Mutex<Listener>>, task_source: NetworkingTaskSource, cancellation_sender: Option<IpcReceiver<()>>, )

pub(crate) fn fetch_with_network_listener<Listener: FetchResponseListener + PreInvoke + Send + 'static>( &self, request_builder: RequestBuilder, network_listener: NetworkListener<Listener>, cancellation_receiver: Option<IpcReceiver<()>>, )

pub fn unminified_js_dir(&self) -> Option<String>

pub(crate) fn set_byte_length_queuing_strategy_size( &self, function: Rc<Function>, )

pub(crate) fn get_byte_length_queuing_strategy_size( &self, ) -> Option<Rc<Function>>

pub(crate) fn set_count_queuing_strategy_size(&self, function: Rc<Function>)

pub(crate) fn get_count_queuing_strategy_size(&self) -> Option<Rc<Function>>

Trait Implementations

impl Castable for GlobalScope

fn is<T>(&self) -> bool

where T: DerivedFrom<Self>,

Check whether a DOM object implements one of its deriving interfaces.

fn upcast<T>(&self) -> &T

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

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

fn downcast<T>(&self) -> Option<&T>

where T: DerivedFrom<Self>,

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

impl DomObject for GlobalScope

fn reflector(&self) -> &Reflector

Returns the receiver’s reflector.

fn global(&self) -> Root<Dom<GlobalScope>>

where Self: Sized,

Returns the global scope of the realm that the DomObject was created in.

impl HasParent for GlobalScope

fn as_parent(&self) -> &EventTarget

This is used in a type assertion to ensure that the source and webidls agree as to what the parent type is

type Parent = EventTarget

impl IDLInterface for GlobalScope

fn derives(class: &'static DOMClass) -> bool

Returns whether the given DOM class derives that interface.

impl MallocSizeOf for GlobalScope

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 MutDomObject for GlobalScope

unsafe fn init_reflector(&self, obj: *mut JSObject)

Initializes the Reflector

impl PartialEq for GlobalScope

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 ToJSValConvertible for GlobalScope

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

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

impl Traceable for GlobalScope

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

Trace self.

impl DerivedFrom<EventTarget> for GlobalScope

impl DerivedFrom<GlobalScope> for DedicatedWorkerGlobalScope

impl DerivedFrom<GlobalScope> for DissimilarOriginWindow

impl DerivedFrom<GlobalScope> for GlobalScope

impl DerivedFrom<GlobalScope> for PaintWorkletGlobalScope

impl DerivedFrom<GlobalScope> for ServiceWorkerGlobalScope

impl DerivedFrom<GlobalScope> for TestWorkletGlobalScope

impl DerivedFrom<GlobalScope> for Window

impl DerivedFrom<GlobalScope> for WorkerGlobalScope

impl DerivedFrom<GlobalScope> for WorkletGlobalScope

impl Eq for GlobalScope