Enum PageRequest 

pub enum PageRequest {
    Outline {
        frame: Option<FrameId>,
    },
    Click {
        element: String,
        frame: Option<FrameId>,
    },
    Hover {
        element: Option<String>,
        point: Option<(f64, f64)>,
    },
    Drag {
        from: Option<String>,
        from_point: Option<(f64, f64)>,
        to: Option<String>,
        to_point: Option<(f64, f64)>,
        steps: u8,
    },
    Path {
        element: Option<String>,
        points: Vec<(f64, f64)>,
    },
    Fill {
        element: String,
        text: String,
        secret: bool,
        frame: Option<FrameId>,
    },
    Select {
        element: String,
        values: Vec<String>,
        frame: Option<FrameId>,
    },
    FillFiles {
        element: String,
        paths: Vec<String>,
        frame: Option<FrameId>,
    },
    Press {
        element: Option<String>,
        key: PageKey,
        frame: Option<FrameId>,
    },
    Submit {
        element: String,
        cross_origin: bool,
        frame: Option<FrameId>,
    },
    Changes {
        frame: Option<FrameId>,
    },
    At {
        x: f64,
        y: f64,
        frame: Option<FrameId>,
    },
    Settle {
        quiet_ms: u32,
        timeout_ms: u32,
        frame: Option<FrameId>,
    },
    Console {
        since: u64,
    },
    Network {
        since: u64,
    },
    Reader {
        enabled: bool,
    },
    Capture {
        element: Option<String>,
        max_width: Option<u32>,
        frame: Option<FrameId>,
    },
    Find {
        role: Option<String>,
        name: Option<String>,
        nth: Option<u32>,
        frame: Option<FrameId>,
    },
    Pointer {
        steps: Vec<PointerStep>,
        button: PointerButton,
    },
    Scroll {
        element: Option<String>,
        to: Option<ScrollTarget>,
        by: Option<i32>,
        into_view: Option<String>,
        frame: Option<FrameId>,
    },
}

Variants

Outline

A compact accessibility outline of the document. Interactive elements carry the refs every other request addresses, and a frame carries the id that addresses its own document.

Fields

frame: Option<FrameId>

Click

A trusted pointer click at the element’s visible centre.

Fields

element: String

frame: Option<FrameId>

Hover

A trusted pointer move to the element’s visible centre, or to the viewport point (x, y) when no element is named: moving the pointer alone, with no button, so the page’s hover styles apply.

Fields

element: Option<String>

point: Option<(f64, f64)>

Drag

A trusted press, move and release on the element’s visible centre, or on the viewport point when no element is named: the drag and drop gesture of a person holding the pointer down and moving it.

Fields

from: Option<String>

from_point: Option<(f64, f64)>

to: Option<String>

to_point: Option<(f64, f64)>

steps: u8

Path

A trusted contact path: press at the first point, move through the rest and release at the last, for drawing on canvases and other surfaces that read pointer contact. Points are viewport CSS pixels when the element is named and are measured from its padding box, otherwise from the viewport’s top left.

Fields

element: Option<String>

points: Vec<(f64, f64)>

Fill

Replace an editable element’s contents with text. A password or card field is refused unless secret says the caller means it, and then the text is a secret the caller keeps out of logs.

Fields

element: String

text: String

secret: bool

frame: Option<FrameId>

Select

Choose <select> options by value or visible label.

Fields

element: String

values: Vec<String>

frame: Option<FrameId>

FillFiles

Choose the files of an <input type=file>, by absolute path.

The caller has already checked each path is a regular file it may read; the engine hands those files to the page as a person’s own picker would, dispatching input and change. A path that names no readable regular file, or one the element’s accept refuses, is refused rather than silently dropped.

Fields

element: String

paths: Vec<String>

frame: Option<FrameId>

Press

A trusted key press, after focusing element when one is named.

Fields

element: Option<String>

key: PageKey

frame: Option<FrameId>

Submit

Submit the element’s form through the page’s own validation. A form that sends its data to another site than the page’s is refused unless cross_origin says the caller means it.

Fields

element: String

cross_origin: bool

frame: Option<FrameId>

Changes

What changed in the outline since this tab’s last read or changes: lines added (+) and removed (-), or the whole outline when the document is new.

Fields

frame: Option<FrameId>

At

The element a click at viewport point (x, y) in CSS pixels would hit, and the nearest interactive element holding it.

Fields

x: f64

y: f64

frame: Option<FrameId>

Settle

Wait until the document has stopped changing for quiet_ms and has loaded, or timeout_ms passed.

Fields

quiet_ms: u32

timeout_ms: u32

frame: Option<FrameId>

Console

Console messages and uncaught errors after sequence number since.

Fields

since: u64

Network

Network requests after sequence number since: method, URL, type, status and failure, never headers, bodies or cookies.

Fields

since: u64

Reader

Show the document’s article alone in a reading layout (enabled), or put the page back as it was. A page without an article is refused.

Fields

enabled: bool

Capture

A picture of the page as it is shown: the box of element when one is named, the viewport otherwise, at most max_width pixels wide. A page can say things no outline reaches, and this is how they are seen. Captured by the engine itself, so the page cannot see or answer it. What the picture shows is page content: never trusted as instructions.

Fields

element: Option<String>

max_width: Option<u32>

frame: Option<FrameId>

Find

The element a stable description names: the same role and name a person reads on it, wherever the document sits in its history.

Every other request addresses an element by the ref one outline printed, and a ref belongs to one document. This one reads the page it is asked of, so a description recorded once is answered with the ref of the page as it is now: what a step replaying a person’s work needs.

Fields

role: Option<String>

name: Option<String>

nth: Option<u32>

frame: Option<FrameId>

Pointer

Move the pointer over the page as a hand does: steps in order, a press and release of button where the page asks for one. A step naming element is placed in that element’s box, every other step is a viewport position in CSS pixels. All of it is real input to the page, so hover, drag and drop and drawing see what a person’s hand would have done, and the reply reports what changed.

Fields

steps: Vec<PointerStep>

button: PointerButton

Scroll

Turn the page’s wheel as a hand does: by CSS pixels down (or up, when negative) at the element’s visible centre, or at the viewport’s when no element is named. to names an end of the page instead, and into_view an element to bring into view. The wheel is real input, so the page’s scroll listeners, lazy loading and intersection observers run as they do for a person, and the reply reports what changed.

Fields

element: Option<String>

to: Option<ScrollTarget>

by: Option<i32>

into_view: Option<String>

frame: Option<FrameId>

Implementations

impl PageRequest

pub const fn action(&self) -> &'static str

pub const fn enters_text(&self) -> bool

Whether the request writes text into the page’s focused field: a fill, or keys pressed. Which field that is, and so whether what it wrote is a credential, is the field’s type, read as it settles.

pub const fn only_observes(&self) -> bool

Whether the request only looks at the page, as any visitor can: it reads the document, its picture, its messages or its requests, or waits for it, and the page sees none of it. Everything else acts on the page: it moves the pointer, types, scrolls, submits or changes how the page is shown.

pub fn described(&self) -> String

What the request does, in the words an answer that a dialog it opened cut short repeats: Clicked element d1e5, Submitted form d1e7.

pub fn element(&self) -> Option<&str>

pub fn frame(&self) -> Option<&FrameId>

The frame’s document this request runs in, or the main document’s.

pub fn main_frame(self) -> PageRequest

The same request run in the main document again.

pub fn frame_valid(&self) -> bool

Whether this request names a frame the page outline could have printed. A caller that makes one up is refused, never silently run against the main document instead.

pub fn valid(&self) -> bool

Whether every field is within the bounds an engine accepts.

Trait Implementations

impl Clone for PageRequest

fn clone(&self) -> PageRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PageRequest

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

Formats the value using the given formatter.

impl PartialEq for PageRequest

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