Skip to main content

BrowserType

Struct BrowserType 

Source
pub struct BrowserType { /* private fields */ }
Expand description

Playwright-shaped browser factory. Construct via chromium / firefox / webkit (top-level free functions in this crate) or BrowserType::chromium_with for the Chromium transport override.

Copy because the type is just two enum tags — keeping it copy lets callers write chromium().launch(opts) without having to bind the factory to a let first when reusing it across multiple launches.

Implementations§

Source§

impl BrowserType

Source

pub fn chromium() -> Self

Construct a Chromium BrowserType. Equivalent to the top-level chromium function. Defaults to the CDP-pipe transport.

Source

pub fn chromium_with(opts: &BrowserTypeOptions) -> Self

Construct a Chromium BrowserType with explicit BrowserTypeOptions. transport: Some(Ws) switches to the CDP-over-WebSocket backend (CdpRaw) instead of the pipe default.

Source

pub fn firefox() -> Self

Construct a Firefox BrowserType. Equivalent to the top-level firefox function.

Source

pub fn webkit() -> Self

Construct a WebKit BrowserType. Equivalent to the top-level webkit function. Only meaningfully usable on macOS — the Self::launch path returns a typed error elsewhere.

Source

pub fn with_backend(kind: BrowserKind, backend: BackendKind) -> Self

Rust-only escape hatch used by the test runner to pin both the product and the wire backend explicitly. NOT exposed in the JS bindings — it’s intended for the test scaffolding that needs to hold BrowserKind::Chromium + BackendKind::CdpRaw (etc.) without going through chromium_with({ transport: Ws }).

Source

pub fn name(self) -> &'static str

Playwright BrowserType.name()"chromium" / "firefox" / "webkit".

Source

pub fn kind(self) -> BrowserKind

Underlying BrowserKind.

Source

pub fn executable_path(self) -> Option<PathBuf>

Path where ferridriver expects to find a bundled browser executable. Mirrors Playwright’s BrowserType.executablePath(). Returns None if no bundled binary is available for this product on the current platform.

Source

pub async fn launch(self, options: LaunchOptions) -> Result<Browser>

Playwright: browserType.launch(options?) -> Browser.

§Errors

Returns an error if the browser process fails to start.

Source

pub async fn connect( self, ws_endpoint: &str, options: ConnectOptions, ) -> Result<Browser>

Playwright: browserType.connect(wsEndpoint, options?) -> Browser.

ferridriver currently has no Playwright-server protocol of its own; this accepts a CDP WebSocket endpoint and behaves like Self::connect_over_cdp under the hood. Kept as a separate method for surface parity with Playwright.

§Errors

Returns an error if the WebSocket handshake fails.

Source

pub async fn connect_over_cdp( self, endpoint_url: &str, _options: ConnectOverCdpOptions, ) -> Result<Browser>

Playwright: browserType.connectOverCDP(endpointURL, options?) -> Browser. Chromium-only.

§Errors

Returns an error if the WebSocket handshake fails or the product is not Chromium.

Source

pub async fn launch_persistent_context( &self, user_data_dir: &Path, options: LaunchPersistentContextOptions, ) -> Result<ContextRef>

Playwright: browserType.launchPersistentContext(userDataDir, options?) -> BrowserContext. Launches a browser whose default context shares storage with the supplied user-data directory and applies the provided BrowserContextOptions to that default context. Returns the default ContextRef; closing the returned context (or the underlying browser) terminates the launch.

§Errors

Returns an error if the browser process fails to start.

Trait Implementations§

Source§

impl Clone for BrowserType

Source§

fn clone(&self) -> BrowserType

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 BrowserType

Source§

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

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

impl Copy for BrowserType

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<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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,