Skip to main content

Browser

Struct Browser 

Source
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

Source

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]>): this
Source

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]>): this
Source

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]): boolean
Source

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]>): this
Source

pub async fn listener_count(&self, type_: Value) -> Result<f64, BridgeError>

EventEmitter.listenerCount

listenerCount(type: keyof EventsWithWildcard<Events>): number
Source

pub async fn remove_all_listeners( &self, type_: Option<Value>, ) -> Result<Browser, BridgeError>

EventEmitter.removeAllListeners

removeAllListeners(type?: keyof EventsWithWildcard<Events>): this
Source

pub async fn process(&self) -> Result<Option<Value>, BridgeError>

Browser.process

process(): ChildProcess | null
Source

pub async fn create_browser_context( &self, options: Option<Value>, ) -> Result<BrowserContext, BridgeError>

Browser.createBrowserContext

createBrowserContext(options?: BrowserContextOptions): Promise<BrowserContext>
Source

pub async fn browser_contexts(&self) -> Result<Vec<BrowserContext>, BridgeError>

Browser.browserContexts

browserContexts(): BrowserContext[]
Source

pub async fn default_browser_context( &self, ) -> Result<BrowserContext, BridgeError>

Browser.defaultBrowserContext

defaultBrowserContext(): BrowserContext
Source

pub async fn ws_endpoint(&self) -> Result<String, BridgeError>

Browser.wsEndpoint

wsEndpoint(): string
Source

pub async fn new_page( &self, options: Option<Value>, ) -> Result<Page, BridgeError>

Browser.newPage

newPage(options?: CreatePageOptions): Promise<Page>
Source

pub async fn get_window_bounds( &self, window_id: &str, ) -> Result<Value, BridgeError>

Browser.getWindowBounds

getWindowBounds(windowId: WindowId): Promise<WindowBounds>
Source

pub async fn set_window_bounds( &self, window_id: &str, window_bounds: Value, ) -> Result<(), BridgeError>

Browser.setWindowBounds

setWindowBounds(windowId: WindowId, windowBounds: WindowBounds): Promise<void>
Source

pub async fn targets(&self) -> Result<Vec<Target>, BridgeError>

Browser.targets

targets(): Target[]
Source

pub async fn target(&self) -> Result<Target, BridgeError>

Browser.target

target(): Target
Source

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>
Source

pub async fn pages( &self, include_all: Option<bool>, ) -> Result<Vec<Page>, BridgeError>

Browser.pages

pages(includeAll?: boolean): Promise<Page[]>
Source

pub async fn version(&self) -> Result<String, BridgeError>

Browser.version

version(): Promise<string>
Source

pub async fn user_agent(&self) -> Result<String, BridgeError>

Browser.userAgent

userAgent(): Promise<string>
Source

pub async fn close(&self) -> Result<(), BridgeError>

Browser.close

close(): Promise<void>
Source

pub async fn disconnect(&self) -> Result<(), BridgeError>

Browser.disconnect

disconnect(): Promise<void>
Source

pub async fn cookies(&self) -> Result<Vec<Value>, BridgeError>

Browser.cookies

cookies(): Promise<Cookie[]>

Browser.setCookie

setCookie(...cookies: CookieData[]): Promise<void>

Browser.deleteCookie

deleteCookie(...cookies: Cookie[]): Promise<void>
Source

pub async fn delete_matching_cookies( &self, filters: &[Value], ) -> Result<(), BridgeError>

Browser.deleteMatchingCookies

deleteMatchingCookies(...filters: DeleteCookiesRequest[]): Promise<void>
Source

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>
Source

pub async fn install_extension( &self, path: &str, options: Option<Value>, ) -> Result<String, BridgeError>

Browser.installExtension

installExtension(path: string, options?: ExtensionInstallOptions): Promise<string>
Source

pub async fn uninstall_extension(&self, id: &str) -> Result<(), BridgeError>

Browser.uninstallExtension

uninstallExtension(id: string): Promise<void>
Source

pub async fn install_pwa(&self, options: Value) -> Result<String, BridgeError>

Browser.installPWA

installPWA(options: InstallPWAOptions): Promise<string>
Source

pub async fn uninstall_pwa(&self, options: Value) -> Result<(), BridgeError>

Browser.uninstallPWA

uninstallPWA(options: UninstallPWAOptions): Promise<void>
Source

pub async fn launch_pwa(&self, options: Value) -> Result<Page, BridgeError>

Browser.launchPWA

launchPWA(options: LaunchPWAOptions): Promise<Page>
Source

pub async fn get_pwa_state(&self, options: Value) -> Result<Value, BridgeError>

Browser.getPWAState

getPWAState(options: GetPWAStateOptions): Promise<PWAState>
Source

pub async fn screens(&self) -> Result<Vec<Value>, BridgeError>

Browser.screens

screens(): Promise<ScreenInfo[]>
Source

pub async fn add_screen(&self, params: Value) -> Result<Value, BridgeError>

Browser.addScreen

addScreen(params: AddScreenParams): Promise<ScreenInfo>
Source

pub async fn remove_screen(&self, screen_id: &str) -> Result<(), BridgeError>

Browser.removeScreen

removeScreen(screenId: string): Promise<void>
Source

pub async fn connected(&self) -> Result<bool, BridgeError>

Browser.connected

get connected(): boolean
Source

pub async fn debug_info(&self) -> Result<Value, BridgeError>

Browser.debugInfo

get debugInfo(): DebugInfo
Source

pub async fn extensions(&self) -> Result<Value, BridgeError>

Browser.extensions

extensions(): Promise<Map<string, Extension>>

Trait Implementations§

Source§

impl Clone for Browser

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Browser

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromWire for Browser

Source§

fn from_wire(client: &BridgeClient, value: Value) -> Result<Self, BridgeError>

Convert, failing with BridgeError::Decode on a type mismatch.
Source§

impl PartialEq for Browser

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Remote for Browser

Source§

const TYPE: &'static str = "Browser"

The Puppeteer type it wraps (Page).
Source§

fn from_remote(remote: RemoteHandle) -> Self

Wrap a handle without checking its type.
Source§

fn remote(&self) -> &RemoteHandle

The handle behind the wrapper.
Source§

fn cast<T: Remote>(&self) -> T

View the same object as another type, for example an ElementHandle as the JSHandle it extends.
Source§

impl StructuralPartialEq for Browser

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert 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>

Convert 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)

Convert &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)

Convert &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
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts 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
Source§

impl<T> MaybeSendSync for T

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more