pub struct Browser { /* private fields */ }Expand description
Puppeteer’s Browser (puppeteer-core 25.10.0), a remote object
served by browser-commander serve --stdio.
Extends EventEmitter; the inherited methods are repeated here.
Implementations§
Source§impl Browser
impl Browser
Sourcepub async fn on(
&self,
type_: Value,
handler: impl Into<JsFunction>,
) -> Result<Browser, BridgeError>
pub async fn on( &self, type_: Value, handler: impl Into<JsFunction>, ) -> Result<Browser, BridgeError>
EventEmitter.on
on<Key extends keyof EventsWithWildcard<Events>>(type: Key, handler: Handler<EventsWithWildcard<Events>[Key]>): thisSourcepub async fn off(
&self,
type_: Value,
handler: Option<JsFunction>,
) -> Result<Browser, BridgeError>
pub async fn off( &self, type_: Value, handler: Option<JsFunction>, ) -> Result<Browser, BridgeError>
EventEmitter.off
off<Key extends keyof EventsWithWildcard<Events>>(type: Key, handler?: Handler<EventsWithWildcard<Events>[Key]>): thisSourcepub async fn emit(
&self,
type_: Value,
event: Value,
) -> Result<bool, BridgeError>
pub async fn emit( &self, type_: Value, event: Value, ) -> Result<bool, BridgeError>
EventEmitter.emit
emit<Key extends keyof EventsWithWildcard<Events>>(type: Key, event: EventsWithWildcard<Events>[Key]): booleanSourcepub async fn once(
&self,
type_: Value,
handler: impl Into<JsFunction>,
) -> Result<Browser, BridgeError>
pub async fn once( &self, type_: Value, handler: impl Into<JsFunction>, ) -> Result<Browser, BridgeError>
EventEmitter.once
once<Key extends keyof EventsWithWildcard<Events>>(type: Key, handler: Handler<EventsWithWildcard<Events>[Key]>): thisSourcepub async fn listener_count(&self, type_: Value) -> Result<f64, BridgeError>
pub async fn listener_count(&self, type_: Value) -> Result<f64, BridgeError>
EventEmitter.listenerCount
listenerCount(type: keyof EventsWithWildcard<Events>): numberSourcepub async fn remove_all_listeners(
&self,
type_: Option<Value>,
) -> Result<Browser, BridgeError>
pub async fn remove_all_listeners( &self, type_: Option<Value>, ) -> Result<Browser, BridgeError>
EventEmitter.removeAllListeners
removeAllListeners(type?: keyof EventsWithWildcard<Events>): thisSourcepub async fn process(&self) -> Result<Option<Value>, BridgeError>
pub async fn process(&self) -> Result<Option<Value>, BridgeError>
Browser.process
process(): ChildProcess | nullSourcepub async fn create_browser_context(
&self,
options: Option<Value>,
) -> Result<BrowserContext, BridgeError>
pub async fn create_browser_context( &self, options: Option<Value>, ) -> Result<BrowserContext, BridgeError>
Browser.createBrowserContext
createBrowserContext(options?: BrowserContextOptions): Promise<BrowserContext>Sourcepub async fn browser_contexts(&self) -> Result<Vec<BrowserContext>, BridgeError>
pub async fn browser_contexts(&self) -> Result<Vec<BrowserContext>, BridgeError>
Browser.browserContexts
browserContexts(): BrowserContext[]Sourcepub async fn default_browser_context(
&self,
) -> Result<BrowserContext, BridgeError>
pub async fn default_browser_context( &self, ) -> Result<BrowserContext, BridgeError>
Browser.defaultBrowserContext
defaultBrowserContext(): BrowserContextSourcepub async fn ws_endpoint(&self) -> Result<String, BridgeError>
pub async fn ws_endpoint(&self) -> Result<String, BridgeError>
Browser.wsEndpoint
wsEndpoint(): stringSourcepub async fn new_page(
&self,
options: Option<Value>,
) -> Result<Page, BridgeError>
pub async fn new_page( &self, options: Option<Value>, ) -> Result<Page, BridgeError>
Browser.newPage
newPage(options?: CreatePageOptions): Promise<Page>Sourcepub async fn get_window_bounds(
&self,
window_id: &str,
) -> Result<Value, BridgeError>
pub async fn get_window_bounds( &self, window_id: &str, ) -> Result<Value, BridgeError>
Browser.getWindowBounds
getWindowBounds(windowId: WindowId): Promise<WindowBounds>Sourcepub async fn set_window_bounds(
&self,
window_id: &str,
window_bounds: Value,
) -> Result<(), BridgeError>
pub async fn set_window_bounds( &self, window_id: &str, window_bounds: Value, ) -> Result<(), BridgeError>
Browser.setWindowBounds
setWindowBounds(windowId: WindowId, windowBounds: WindowBounds): Promise<void>Sourcepub async fn targets(&self) -> Result<Vec<Target>, BridgeError>
pub async fn targets(&self) -> Result<Vec<Target>, BridgeError>
Browser.targets
targets(): Target[]Sourcepub async fn target(&self) -> Result<Target, BridgeError>
pub async fn target(&self) -> Result<Target, BridgeError>
Browser.target
target(): TargetSourcepub async fn wait_for_target(
&self,
predicate: impl Into<JsFunction>,
options: Option<Value>,
) -> Result<Target, BridgeError>
pub async fn wait_for_target( &self, predicate: impl Into<JsFunction>, options: Option<Value>, ) -> Result<Target, BridgeError>
Browser.waitForTarget
waitForTarget(predicate: (x: Target) => boolean | Promise<boolean>, options?: WaitForTargetOptions): Promise<Target>Sourcepub async fn pages(
&self,
include_all: Option<bool>,
) -> Result<Vec<Page>, BridgeError>
pub async fn pages( &self, include_all: Option<bool>, ) -> Result<Vec<Page>, BridgeError>
Browser.pages
pages(includeAll?: boolean): Promise<Page[]>Sourcepub async fn version(&self) -> Result<String, BridgeError>
pub async fn version(&self) -> Result<String, BridgeError>
Browser.version
version(): Promise<string>Sourcepub async fn user_agent(&self) -> Result<String, BridgeError>
pub async fn user_agent(&self) -> Result<String, BridgeError>
Browser.userAgent
userAgent(): Promise<string>Sourcepub async fn close(&self) -> Result<(), BridgeError>
pub async fn close(&self) -> Result<(), BridgeError>
Browser.close
close(): Promise<void>Sourcepub async fn disconnect(&self) -> Result<(), BridgeError>
pub async fn disconnect(&self) -> Result<(), BridgeError>
Browser.disconnect
disconnect(): Promise<void>Browser.cookies
cookies(): Promise<Cookie[]>Browser.setCookie
setCookie(...cookies: CookieData[]): Promise<void>Browser.deleteCookie
deleteCookie(...cookies: Cookie[]): Promise<void>Browser.deleteMatchingCookies
deleteMatchingCookies(...filters: DeleteCookiesRequest[]): Promise<void>Sourcepub async fn set_permission(
&self,
origin: &str,
permissions: &[Value],
) -> Result<(), BridgeError>
pub async fn set_permission( &self, origin: &str, permissions: &[Value], ) -> Result<(), BridgeError>
Browser.setPermission
setPermission(origin: string, ...permissions: Array<{ permission: PermissionDescriptor_2; state: PermissionState_2; }> ): Promise<void>Sourcepub async fn install_extension(
&self,
path: &str,
options: Option<Value>,
) -> Result<String, BridgeError>
pub async fn install_extension( &self, path: &str, options: Option<Value>, ) -> Result<String, BridgeError>
Browser.installExtension
installExtension(path: string, options?: ExtensionInstallOptions): Promise<string>Sourcepub async fn uninstall_extension(&self, id: &str) -> Result<(), BridgeError>
pub async fn uninstall_extension(&self, id: &str) -> Result<(), BridgeError>
Browser.uninstallExtension
uninstallExtension(id: string): Promise<void>Sourcepub async fn install_pwa(&self, options: Value) -> Result<String, BridgeError>
pub async fn install_pwa(&self, options: Value) -> Result<String, BridgeError>
Browser.installPWA
installPWA(options: InstallPWAOptions): Promise<string>Sourcepub async fn uninstall_pwa(&self, options: Value) -> Result<(), BridgeError>
pub async fn uninstall_pwa(&self, options: Value) -> Result<(), BridgeError>
Browser.uninstallPWA
uninstallPWA(options: UninstallPWAOptions): Promise<void>Sourcepub async fn launch_pwa(&self, options: Value) -> Result<Page, BridgeError>
pub async fn launch_pwa(&self, options: Value) -> Result<Page, BridgeError>
Browser.launchPWA
launchPWA(options: LaunchPWAOptions): Promise<Page>Sourcepub async fn get_pwa_state(&self, options: Value) -> Result<Value, BridgeError>
pub async fn get_pwa_state(&self, options: Value) -> Result<Value, BridgeError>
Browser.getPWAState
getPWAState(options: GetPWAStateOptions): Promise<PWAState>Sourcepub async fn screens(&self) -> Result<Vec<Value>, BridgeError>
pub async fn screens(&self) -> Result<Vec<Value>, BridgeError>
Browser.screens
screens(): Promise<ScreenInfo[]>Sourcepub async fn add_screen(&self, params: Value) -> Result<Value, BridgeError>
pub async fn add_screen(&self, params: Value) -> Result<Value, BridgeError>
Browser.addScreen
addScreen(params: AddScreenParams): Promise<ScreenInfo>Sourcepub async fn remove_screen(&self, screen_id: &str) -> Result<(), BridgeError>
pub async fn remove_screen(&self, screen_id: &str) -> Result<(), BridgeError>
Browser.removeScreen
removeScreen(screenId: string): Promise<void>Sourcepub async fn connected(&self) -> Result<bool, BridgeError>
pub async fn connected(&self) -> Result<bool, BridgeError>
Browser.connected
get connected(): booleanSourcepub async fn debug_info(&self) -> Result<Value, BridgeError>
pub async fn debug_info(&self) -> Result<Value, BridgeError>
Browser.debugInfo
get debugInfo(): DebugInfoSourcepub async fn extensions(&self) -> Result<Value, BridgeError>
pub async fn extensions(&self) -> Result<Value, BridgeError>
Browser.extensions
extensions(): Promise<Map<string, Extension>>Trait Implementations§
Source§impl FromWire for Browser
impl FromWire for Browser
Source§fn from_wire(client: &BridgeClient, value: Value) -> Result<Self, BridgeError>
fn from_wire(client: &BridgeClient, value: Value) -> Result<Self, BridgeError>
BridgeError::Decode on a type mismatch.Source§impl Remote for Browser
impl Remote for Browser
Source§fn from_remote(remote: RemoteHandle) -> Self
fn from_remote(remote: RemoteHandle) -> Self
Source§fn remote(&self) -> &RemoteHandle
fn remote(&self) -> &RemoteHandle
impl StructuralPartialEq for Browser
Auto Trait Implementations§
impl !RefUnwindSafe for Browser
impl !UnwindSafe for Browser
impl Freeze for Browser
impl Send for Browser
impl Sync for Browser
impl Unpin for Browser
impl UnsafeUnpin for Browser
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
impl<T> ErasedDestructor for Twhere
T: 'static,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more