Enum WebViewCommand 

pub enum WebViewCommand {
    DevTools {
        request_id: u32,
        method: String,
        params: Value,
        session: Option<String>,
    },
    Credentials(CredentialRequest),
    ImportServiceSession(ServiceSessionRequest),
    SetSiteExceptions(Vec<String>),
    RequestSiteStatus {
        request_id: u32,
        origin: String,
    },
    SiteAction {
        request_id: u32,
        origin: String,
        generation: u64,
        action: String,
    },
    Navigate(String),
    ScopedNavigation {
        request_id: u32,
        command: NavigationCommand,
    },
    CancelScopedNavigation {
        request_id: u32,
    },
    RequestNavigationHistory {
        request_id: u32,
        direction: NavigationDirection,
    },
    NavigateToHistoryEntry {
        request_id: u32,
        id: u32,
    },
    GoBack,
    GoForward,
    Reload,
    StopLoading,
    ExitFullscreen,
    SetAudioMuted(bool),
    Find {
        id: u32,
        text: String,
        forward: bool,
        next: bool,
    },
    StopFinding,
    ContextMenuAction {
        id: u32,
        command: u32,
    },
    AnswerPageDialog {
        id: u32,
        accept: bool,
        text: Option<String>,
    },
    SetZoomLevel(f64),
    ReportDocumentSize(bool),
    CopySelection {
        request_id: u32,
    },
    AnswerClipboardRead {
        request_id: u32,
        text: Option<String>,
    },
    Resize {
        width: u32,
        height: u32,
        scale_factor: f32,
    },
    MouseMove {
        x: f32,
        y: f32,
    },
    MouseButton {
        button: MouseButton,
        down: bool,
        x: f32,
        y: f32,
    },
    Scroll {
        dx: f32,
        dy: f32,
        x: f32,
        y: f32,
    },
    Key {
        key: KeyInput,
        down: bool,
        modifiers: KeyModifiers,
        code: Option<&'static str>,
    },
    ImeComposition {
        text: String,
        cursor: Option<(usize, usize)>,
    },
    ImeCommit(String),
    ImeCancel,
    ImeFinish,
    SetFocused(bool),
    SetContentFilter(Option<Arc<String>>),
    SetNativeFilterRules {
        rules: Arc<String>,
        enabled: Option<bool>,
    },
    SetContentFilters {
        version: u64,
        chunks: Arc<Vec<Arc<String>>>,
    },
    SetUserScripts(Arc<Vec<String>>),
    SetBlockingScripts(Arc<Vec<String>>),
    RequestMediaElement {
        request_id: u64,
    },
    RequestMediaElementById {
        request_id: u64,
        element_id: String,
    },
    Page {
        request_id: u32,
        request: PageRequest,
    },
    CancelPage,
    PaintCapture {
        request_id: u32,
    },
    PaintResource {
        request_id: u32,
        url: String,
    },
    ClearWebsiteData,
    SetClearOnExit(bool),
    ShowDeveloperTools,
    PermissionDecision {
        id: u32,
        allow: bool,
    },
    PermissionDismissed {
        id: u32,
    },
    ExtensionAccess {
        id: String,
        permissions: Vec<String>,
        hosts: Vec<String>,
        scriptable: Vec<String>,
        framed: Vec<String>,
        token: Option<String>,
        commands: Option<Value>,
    },
    ExtensionGrants {
        id: String,
        optional: ExtensionPermissionSet,
        granted: ExtensionPermissionSet,
    },
    ExtensionPermissionDecision {
        request: u32,
        allow: bool,
    },
    ExtensionForget {
        id: String,
    },
    ExtensionIdentity {
        id: String,
    },
    ExtensionPanel {
        action: Option<String>,
    },
    ExtensionSignInPanel {
        id: String,
        flow: u32,
    },
    ExtensionClick {
        id: String,
    },
    ExtensionMenuChoice {
        id: String,
        key: String,
    },
    ExtensionNotificationChosen {
        id: String,
        notification: String,
        button: Option<u8>,
    },
    ExtensionOmnibox {
        id: String,
        input: OmniboxInput,
    },
    ExtensionOpenSidePanel {
        id: String,
    },
    ExtensionSidePanelPage {
        id: String,
    },
    ExtensionCommandKey {
        key: KeyInput,
        modifiers: KeyModifiers,
    },
    DownloadDecision {
        id: u32,
        allow: bool,
    },
    CancelNativeDownload {
        id: u32,
    },
    RetryDownload {
        id: u32,
    },
    CancelAllDownloads,
    StartDownload {
        uri: String,
    },
    SetDownloadDestination {
        id: String,
        path: String,
    },
    CancelDownload {
        id: String,
    },
}

Variants

DevTools

A DevTools command for extension management: the engine allows only the Extensions domain and what reading an extension’s service worker needs. The reply is a WebViewEvent::DevToolsResult with the same request_id. session addresses an attached service-worker target.

Fields

request_id: u32

method: String

params: Value

session: Option<String>

Credentials(CredentialRequest)

ImportServiceSession(ServiceSessionRequest)

SetSiteExceptions(Vec<String>)

RequestSiteStatus

Fields

request_id: u32

origin: String

SiteAction

Fields

request_id: u32

origin: String

generation: u64

action: String

Navigate(String)

Load the given (already normalised) URL.

ScopedNavigation

Transport representation only: use WebViewEngine::navigate_owned to observe admission before relying on an owned outcome.

Fields

request_id: u32

command: NavigationCommand

CancelScopedNavigation

Fields

request_id: u32

RequestNavigationHistory

Fields

request_id: u32

direction: NavigationDirection

NavigateToHistoryEntry

Fields

request_id: u32

id: u32

GoBack

GoForward

Reload

StopLoading

ExitFullscreen

Ask the native browser host to leave document/video fullscreen.

SetAudioMuted(bool)

Mute or restore native page audio without installing an audio capture handler.

Find

Fields

id: u32

text: String

forward: bool

next: bool

StopFinding

ContextMenuAction

Fields

id: u32

command: u32

AnswerPageDialog

Answer the page’s question id: OK (or Leave) when accept, else Cancel (or Stay), with a prompt’s text.

Fields

id: u32

accept: bool

text: Option<String>

SetZoomLevel(f64)

ReportDocumentSize(bool)

Report the document’s size and scroll as WebViewEvent::DocumentSize whenever they change, or stop. Off until asked: an embedder that sizes the view to its content asks (a mail reader scrolling as one page). An engine that cannot measure never reports.

CopySelection

Read the page’s selection as text, answered by one WebViewEvent::SelectionText with the same id, for the embedder to put on the system clipboard. An engine that cannot read it never answers.

Fields

request_id: u32

AnswerClipboardRead

The system clipboard’s text, answering WebViewEvent::ClipboardRead with the same id: None when it holds no text or could not be read, which leaves the page the engine’s own.

Fields

request_id: u32

text: Option<String>

Resize

Viewport size in physical pixels plus the display scale factor.

Fields

width: u32

height: u32

scale_factor: f32

MouseMove

Fields

x: f32

y: f32

MouseButton

Fields

button: MouseButton

down: bool

x: f32

y: f32

Scroll

Scroll by (dx, dy) physical pixels at pointer position (x, y).

Fields

dx: f32

dy: f32

x: f32

y: f32

Key

Fields

key: KeyInput

down: bool

modifiers: KeyModifiers

code: Option<&'static str>

The key’s place on the keyboard, as a DOM KeyboardEvent.code (“KeyZ”, “Digit1”), whatever the layout prints on it. A page’s shortcuts keep working on a layout whose letters are not Latin (Ctrl+С on a Russian layout copies), and its code is the key pressed. None when the sender does not know it.

ImeComposition

The input method’s text being composed at the page’s caret, in place of any composed before. cursor is the composition’s own caret or selection, as byte offsets into text.

Fields

text: String

cursor: Option<(usize, usize)>

ImeCommit(String)

Text the input method committed: it takes the composition’s place, or goes in at the caret when nothing is being composed.

ImeCancel

The input method withdrew its composition: the composed text leaves the page.

ImeFinish

The composition ends as it stands: its text stays in the page.

SetFocused(bool)

Keyboard focus entered / left the page surface.

SetContentFilter(Option<Arc<String>>)

Compiled WebKit content-blocker JSON (None clears the filter). Backends without native content filtering ignore this.

SetNativeFilterRules

Source filter rules for engines with native matching. An empty source preserves current rules. None preserves the enabled state, so an asynchronous list refresh cannot undo a user’s disable action.

Fields

rules: Arc<String>

enabled: Option<bool>

SetContentFilters

Several compiled content-blocker JSON blobs, split because the full filter-list rule set exceeds WebKit’s per-filter cap. An empty chunks clears all filters.

version hashes the source filter lists (not the compiled JSON, since compiler rule ordering isn’t stable across runs); the engine caches each compiled filter under version+index so an unchanged rule set loads from disk instead of recompiling (~280k rules costs several seconds).

Fields

version: u64

chunks: Arc<Vec<Arc<String>>>

SetUserScripts(Arc<Vec<String>>)

Scriptlet-style blocking the declarative content filter can’t express (e.g. skipping YouTube video ads). Run at document-start in all frames.

SetBlockingScripts(Arc<Vec<String>>)

Native blocker supplements, guarded by the top-level site policy.

RequestMediaElement

Find the most useful visible HTML video in the current page. The result is delivered asynchronously as WebViewEvent::MediaElement or WebViewEvent::MediaElementUnavailable. Browser chrome uses the returned viewport geometry to create a live, element-sized PiP rather than mirroring the whole page.

Fields

request_id: u64

RequestMediaElementById

Re-resolve a previously selected media element by its stable page-local identity. Active PiP uses this without silently switching videos.

Fields

request_id: u64

element_id: String

Page

Read or operate the current page’s content. Exactly one WebViewEvent::PageResult with the same id answers it; engines without page automation answer PageFailure::unavailable.

Fields

request_id: u32

request: PageRequest

CancelPage

Stop the page action that is running. An action nobody waits for any more must not hold the page: the tab answers it as settled with an unknown outcome rather than running the next action behind it. No request id is carried: a tab runs one page action at a time, so the action that is running is the one to stop.

PaintCapture

Capture the page’s layout for the paint stream: every box and text line the engine laid out (see tilo_paint_stream::snapshot). Exactly one WebViewEvent::PaintSnapshot with the same id answers it.

Fields

request_id: u32

PaintResource

The bytes of a resource the page already loaded, read from the engine’s cache. One WebViewEvent::PaintResource answers it.

Fields

request_id: u32

url: String

ClearWebsiteData

Clear all persistent website data (cookies, caches, storage, service workers). Backends without a data store ignore this.

SetClearOnExit(bool)

ShowDeveloperTools

PermissionDecision

Fields

id: u32

allow: bool

PermissionDismissed

The person set a permission question aside (Escape, a click elsewhere) without answering: the site may ask again, as when a prompt in Chrome is dismissed. An engine that cannot tell this from no takes it as no.

Fields

id: u32

ExtensionAccess

What an installed extension may do with the Browser’s tabs: its API permissions and the sites it may read and script. The engine answers the extension’s tab APIs within them.

Fields

id: String

permissions: Vec<String>

hosts: Vec<String>

Its host permissions: the sites the tab APIs let it read and script.

scriptable: Vec<String>

Where its declared content scripts run, which, as in Chrome, gives no access to the tab APIs.

framed: Vec<String>

Where they run in a page’s frames too (all_frames).

token: Option<String>

What its service worker shows the engine to be known as its.

commands: Option<Value>

Its keyboard shortcuts: the manifest’s commands object, whose suggested keys the engine gives and runs.

ExtensionGrants

What an extension may ask for later (its manifest’s optional_permissions and optional_host_permissions), and what of it the person granted: the engine answers chrome.permissions within them, and its tab APIs within what was granted too.

Fields

id: String

optional: ExtensionPermissionSet

granted: ExtensionPermissionSet

ExtensionPermissionDecision

The person answered an extension’s request for more access (WebViewEvent::ExtensionPermissionRequest).

Fields

request: u32

allow: bool

ExtensionForget

An extension that left the profile: it is told nothing more.

Fields

id: String

ExtensionIdentity

The Browser’s own extension, which tells the engine which tab a page is among the ids extensions know tabs by.

Fields

id: String

ExtensionPanel

This tab shows an extension’s popup or settings page over the page used last: to extensions it is no tab, and that page is its window. action names the extension whose toolbar button opened it, which may then script that page, as in Chrome.

Fields

action: Option<String>

ExtensionSignInPanel

This tab shows the page of sign-in flow of extension id (WebViewEvent::ExtensionSignIn), over the page used last or out of sight: to extensions it is no tab, and its closing turns the sign-in down.

Fields

id: String

flow: u32

ExtensionClick

The person clicked an extension’s toolbar button over this page: the extension hears of it (action.onClicked) and may script the page, or its side panel opens or closes when it asked for that.

Fields

id: String

ExtensionMenuChoice

The person chose the item key of extension id’s toolbar button menu over this page: the extension hears of it (contextMenus.onClicked).

Fields

id: String

key: String

ExtensionNotificationChosen

The person chose the notification notification of the extension id: its body, or the button at button. The extension hears of it and of the notification closing.

Fields

id: String

notification: String

button: Option<u8>

ExtensionOmnibox

The person typed after the extension’s keyword in this page’s address: the extension hears of it (chrome.omnibox), and Enter lets it act on the page as a click on its button would.

Fields

id: String

input: OmniboxInput

ExtensionOpenSidePanel

The person opened an extension’s side panel beside this page: the engine answers with WebViewEvent::ExtensionSidePanel once the extension says which of its pages it shows here, if any.

Fields

id: String

ExtensionSidePanelPage

This tab shows extension id’s side panel beside the page used last: to extensions it is no tab and that page is its window, and the extension hears of the panel opening and closing (sidePanel.onOpened, sidePanel.onClosed).

Fields

id: String

ExtensionCommandKey

The person pressed one of extensions’ keyboard shortcuts (WebViewEvent::ExtensionShortcuts) while the Browser’s own field had the keyboard: the extension’s command runs over this tab’s page, and the page sees nothing of the key.

Fields

key: KeyInput

modifiers: KeyModifiers

DownloadDecision

Fields

id: u32

allow: bool

CancelNativeDownload

Fields

id: u32

RetryDownload

Retry a user-selected network GET without navigating the visible page.

Fields

id: u32

CancelAllDownloads

Stop admitting downloads and cancel every pending or active transfer.

StartDownload

Start a user-requested download of an absolute HTTP(S) URL.

Fields

uri: String

SetDownloadDestination

Finish WebKit’s asynchronous destination decision with the exact absolute path granted by the desktop file portal.

Fields

id: String

path: String

CancelDownload

Cancel an awaiting or active download by its engine-issued stable id.

Fields

id: String

Trait Implementations

impl Clone for WebViewCommand

fn clone(&self) -> WebViewCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebViewCommand

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

Formats the value using the given formatter.

impl PartialEq for WebViewCommand

fn eq(&self, other: &WebViewCommand) -> 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 StructuralPartialEq for WebViewCommand