Struct thirtyfour::WebDriver

pub struct WebDriver {
    pub handle: Arc<SessionHandle>,
}

The WebDriver struct encapsulates an async Selenium WebDriver browser session.

Example:

use thirtyfour::prelude::*;

let caps = DesiredCapabilities::firefox();
// NOTE: this assumes you have a WebDriver compatible server running
//       at http://localhost:4444
//       e.g. `geckodriver -p 4444`
// NOTE: If using selenium 3.x, use "http://localhost:4444/wd/hub/session" for the url.
let driver = WebDriver::new("http://localhost:4444", caps).await?;
driver.goto("https://www.rust-lang.org/").await?;
// Always remember to close the session.
driver.quit().await?;

Fields

handle: Arc<SessionHandle>

The underlying session handle.

Implementations

impl WebDriver

pub async fn new<S, C>(server_url: S, capabilities: C) -> WebDriverResult<Self>

where S: Into<String>, C: Into<Capabilities>,

Create a new WebDriver as follows:

Example

let caps = DesiredCapabilities::firefox();
// NOTE: this assumes you have a WebDriver compatible server running
//       at http://localhost:4444
//       e.g. `geckodriver -p 4444`
// NOTE: If using selenium 3.x, use "http://localhost:4444/wd/hub/session" for the url.
let driver = WebDriver::new("http://localhost:4444", caps).await?;

Using Selenium Server

• For selenium 3.x, you need to also add “/wd/hub/session” to the end of the url (e.g. “http://localhost:4444/wd/hub/session”)
• For selenium 4.x and later, no path should be needed on the url.

Troubleshooting

• If the webdriver appears to freeze or give no response, please check that the capabilities’ object is of the correct type for that webdriver.

pub async fn new_with_config<S, C>( server_url: S, capabilities: C, config: WebDriverConfig, ) -> WebDriverResult<Self>

where S: Into<String>, C: Into<Capabilities>,

Create a new WebDriver with the specified WebDriverConfig.

Use WebDriverConfig::builder().build() to construct the config.

pub async fn new_with_config_and_client<S, C>( server_url: S, capabilities: C, config: WebDriverConfig, client: impl HttpClient, ) -> WebDriverResult<Self>

where S: Into<String>, C: Into<Capabilities>,

Create a new WebDriver with the specified WebDriverConfig.

Use WebDriverConfig::builder().build() to construct the config.

pub fn clone_with_config(&self, config: WebDriverConfig) -> Self

Clone this WebDriver keeping the session handle, but supplying a new WebDriverConfig.

This still uses the same underlying client, and still controls the same browser session, but uses a different WebDriverConfig for this instance.

This is useful in cases where you want to specify a custom poller configuration (or some other configuration option) for only one instance of WebDriver.

pub async fn quit(self) -> WebDriverResult<()>

End the webdriver session and close the browser.

NOTE: Although WebDriver does close when all instances go out of scope. When this happens it blocks the current executor, therefore, if you know when a webdriver is no longer used/required call this method and await it to more or less “asynchronously drop” it this also allows you to catch errors during quitting, and possibly panic or report back to the user

pub fn leak(self) -> Result<(), AlreadyClosed>

Leak the webdriver session and prevent it from being closed, use this if you don’t want your driver to automatically close

Trait Implementations

impl Clone for WebDriver

fn clone(&self) -> WebDriver

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebDriver

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

Formats the value using the given formatter.

impl Deref for WebDriver

The Deref implementation allows the WebDriver to “fall back” to SessionHandle and exposes all the methods there without requiring us to use an async_trait. See documentation at the top of this module for more details on the design.

type Target = Arc<SessionHandle>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.