playwright_rs/protocol/
mod.rs

1// Copyright 2026 Paul Adamson
2// Licensed under the Apache License, Version 2.0
3//
4// Protocol Objects - Rust representations of Playwright protocol objects
5//
6// This module contains the Rust implementations of all Playwright protocol objects.
7// Each object corresponds to a type in the Playwright protocol (protocol.yml).
8//
9// Architecture:
10// - All protocol objects implement the ChannelOwner trait
11// - Objects are created by the object factory when server sends __create__ messages
12// - Objects communicate with the server via their Channel
13
14pub mod accessibility;
15pub mod action_options;
16pub mod android;
17pub mod api_request_context;
18pub mod artifact;
19pub mod binding_call;
20pub mod browser;
21pub mod browser_context;
22pub mod browser_type;
23pub mod cdp_session;
24pub mod click;
25pub mod clock;
26pub mod console_message;
27pub mod coverage;
28pub mod device;
29pub mod dialog;
30pub mod download;
31pub mod drag_to;
32pub mod electron;
33pub mod element_handle;
34pub mod evaluate_conversion;
35pub mod event_value;
36pub mod event_waiter;
37pub mod file_chooser;
38pub mod file_payload;
39pub mod frame;
40pub mod frame_locator;
41pub mod js_handle;
42pub mod keyboard;
43pub mod local_utils;
44pub mod locator;
45pub mod mouse;
46pub mod page;
47pub mod playwright;
48pub mod proxy;
49pub mod request;
50pub mod response;
51pub mod root;
52pub mod route;
53pub mod screenshot;
54pub mod select_option;
55pub mod selectors;
56pub mod tap;
57pub mod touchscreen;
58pub mod tracing;
59pub mod video;
60pub mod wait_for;
61pub mod web_error;
62pub mod web_socket;
63pub mod web_socket_route;
64pub mod worker;
65
66pub use accessibility::{Accessibility, AccessibilitySnapshotOptions};
67pub use action_options::{
68    CheckOptions, FillOptions, HoverOptions, KeyboardOptions, MouseOptions, PressOptions,
69    PressSequentiallyOptions, SelectOptions,
70};
71pub use android::Android;
72pub use api_request_context::{
73    APIRequest, APIRequestContext, APIRequestContextOptions, APIResponse,
74};
75pub use binding_call::BindingCall;
76pub use browser::{BindOptions, BindResult, Browser, StartTracingOptions};
77pub use browser_context::{
78    AcceptDownloads, BrowserContext, BrowserContextOptions, BrowserContextOptionsBuilder,
79    ClearCookiesOptions, Cookie, Geolocation, GrantPermissionsOptions, LocalStorageItem, Origin,
80    RecordHar, RecordVideo, StorageState, Viewport,
81};
82pub use browser_type::BrowserType;
83pub use cdp_session::CDPSession;
84pub use click::{ClickOptions, KeyboardModifier, MouseButton, Position};
85pub use clock::{Clock, ClockInstallOptions};
86pub use console_message::{ConsoleMessage, ConsoleMessageLocation};
87pub use coverage::{
88    CSSCoverageEntry, Coverage, CoverageRange, JSCoverageEntry, JSCoverageRange,
89    JSFunctionCoverage, StartCSSCoverageOptions, StartJSCoverageOptions,
90};
91pub use device::{DeviceDescriptor, DeviceViewport};
92pub use dialog::Dialog;
93pub use download::Download;
94pub use drag_to::{DragToOptions, DragToOptionsBuilder};
95pub use electron::Electron;
96pub use element_handle::ElementHandle;
97pub use evaluate_conversion::{parse_result, parse_value, serialize_argument, serialize_null};
98pub use event_value::EventValue;
99pub use event_waiter::EventWaiter;
100pub use file_chooser::FileChooser;
101pub use file_payload::{FilePayload, FilePayloadBuilder};
102pub use frame::Frame;
103pub use frame_locator::FrameLocator;
104pub use js_handle::JSHandle;
105pub use keyboard::Keyboard;
106pub use local_utils::LocalUtils;
107pub use locator::{AriaRole, BoundingBox, FilterOptions, GetByRoleOptions, Locator};
108pub use mouse::Mouse;
109pub use page::{
110    AddLocatorHandlerOptions, AddScriptTagOptions, AddScriptTagOptionsBuilder, AddStyleTagOptions,
111    ColorScheme, EmulateMediaOptions, EmulateMediaOptionsBuilder, ForcedColors, GotoOptions, Media,
112    Page, PdfMargin, PdfOptions, PdfOptionsBuilder, ReducedMotion, Response, RouteFromHarOptions,
113    WaitUntil,
114};
115pub use playwright::Playwright;
116pub use proxy::ProxySettings;
117pub use request::{Request, ResourceTiming};
118pub use response::{HeaderEntry, RemoteAddr, RequestSizes, ResponseObject, SecurityDetails};
119pub use root::Root;
120pub use route::{
121    ContinueOptions, ContinueOptionsBuilder, FetchOptions, FetchOptionsBuilder, FetchResponse,
122    FulfillOptions, FulfillOptionsBuilder, Route, UnrouteBehavior,
123};
124pub use screenshot::{ScreenshotClip, ScreenshotOptions, ScreenshotType};
125pub use select_option::SelectOption;
126pub use selectors::Selectors;
127pub use tap::{TapOptions, TapOptionsBuilder};
128pub use touchscreen::Touchscreen;
129pub use tracing::{Tracing, TracingStartOptions, TracingStopOptions};
130pub use video::Video;
131pub use wait_for::{WaitForOptions, WaitForOptionsBuilder, WaitForState};
132pub use web_error::WebError;
133pub use web_socket::WebSocket;
134pub use web_socket_route::{WebSocketRoute, WebSocketRouteCloseOptions};
135pub use worker::Worker;
playwright_rs/protocol/mod.rs

playwright_rs/protocol/
mod.rs
