Struct thirtyfour::WebDriver

pub struct WebDriver { /* fields omitted */ }

The WebDriver struct encapsulates an async Selenium WebDriver browser session. For the sync driver, see sync::WebDriver.

Example:

use thirtyfour::error::WebDriverResult;
use thirtyfour::{DesiredCapabilities, WebDriver};
use tokio;

#[tokio::main]
async fn main() -> WebDriverResult<()> {
    let caps = DesiredCapabilities::chrome();
    let driver = WebDriver::new("http://localhost:4444/wd/hub", &caps).await?;
    driver.get("http://webappdemo").await?;
    Ok(())
}

Methods

impl WebDriver

pub async fn new<'_, T>(
    remote_server_addr: &'_ str,
    capabilities: T
) -> WebDriverResult<Self> where
    T: Serialize, 

Create a new async WebDriver struct.

Example

let caps = DesiredCapabilities::chrome();
let driver = WebDriver::new("http://localhost:4444/wd/hub", &caps).await?;

pub fn capabilities(&self) -> DesiredCapabilities

Return a clone of the capabilities as returned by Selenium.

pub async fn close<'_>(&'_ self) -> WebDriverResult<()>

Close the current window.

pub async fn quit<'_>(&'_ self) -> WebDriverResult<()>

End the webdriver session.

pub async fn get<'_, S: Into<String>>(&'_ self, url: S) -> WebDriverResult<()>

Navigate to the specified URL.

pub async fn current_url<'_>(&'_ self) -> WebDriverResult<String>

Get the current URL as a String.

pub async fn page_source<'_>(&'_ self) -> WebDriverResult<String>

Get the page source as a String.

pub async fn title<'_>(&'_ self) -> WebDriverResult<String>

Get the page title as a String.

pub async fn find_element<'_, '_>(
    &'_ self,
    by: By<'_>
) -> WebDriverResult<WebElement>

Search for an element on the current page using the specified selector.

Example:

let elem_text = driver.find_element(By::Name("input1")).await?;
let elem_button = driver.find_element(By::Id("button-set")).await?;
let elem_result = driver.find_element(By::Name("input-result")).await?;

pub async fn find_elements<'_, '_>(
    &'_ self,
    by: By<'_>
) -> WebDriverResult<Vec<WebElement>>

Search for all elements on the current page that match the specified selector.

Example:

let elems = driver.find_elements(By::ClassName("section")).await?;
for elem in elems {
    assert!(elem.get_attribute("class").await?.contains("section"));
}

pub async fn execute_script<'_, '_, '_>(
    &'_ self,
    script: &'_ str,
    args: &'_ ScriptArgs
) -> WebDriverResult<ScriptRet>

Execute the specified Javascript synchronously and return the result.

Example:

use thirtyfour::ScriptArgs;
let elem = driver.find_element(By::Id("button1")).await?;
let mut args = ScriptArgs::new();
args.push(elem.clone())?;
args.push("TESTING")?;
let ret = driver.execute_script(r#"
    arguments[0].innerHTML = arguments[1];
    return arguments[0];
    "#, &args
).await?;
let elem_out = ret.get_element()?;
assert_eq!(elem_out.element_id, elem.element_id);
assert_eq!(elem_out.text().await?, "TESTING");

pub async fn execute_async_script<'_, '_, '_>(
    &'_ self,
    script: &'_ str,
    args: &'_ ScriptArgs
) -> WebDriverResult<ScriptRet>

Execute the specified Javascrypt asynchronously and return the result.

Example:

use thirtyfour::ScriptArgs;
let elem = driver.find_element(By::Id("button1")).await?;
let mut args = ScriptArgs::new();
args.push(elem.clone())?;
args.push("TESTING")?;
let ret = driver.execute_async_script(r#"
    // Selenium automatically provides an extra argument which is a
    // function that receives the return value(s).
    let done = arguments[2];
    window.setTimeout(() => {
        arguments[0].innerHTML = arguments[1];
        done(arguments[0]);
    }, 1000);
    "#, &args
).await?;
let elem_out = ret.get_element()?;
assert_eq!(elem_out.element_id, elem.element_id);
assert_eq!(elem_out.text().await?, "TESTING");

pub async fn current_window_handle<'_>(
    &'_ self
) -> WebDriverResult<WindowHandle>

Get the current window handle.

pub async fn window_handles<'_>(&'_ self) -> WebDriverResult<Vec<WindowHandle>>

Get all window handles for the current session.

pub async fn maximize_window<'_>(&'_ self) -> WebDriverResult<()>

Maximize the current window.

Example:

driver.maximize_window().await?;

pub async fn minimize_window<'_>(&'_ self) -> WebDriverResult<()>

Minimize the current window.

pub async fn fullscreen_window<'_>(&'_ self) -> WebDriverResult<()>

Make the current window fullscreen.

Example:

driver.fullscreen_window().await?;

pub async fn get_window_rect<'_>(&'_ self) -> WebDriverResult<Rect>

Get the current window rectangle, in pixels.

The returned Rect struct has members x, y, width, height, all i32.

pub async fn set_window_rect<'_>(
    &'_ self,
    rect: OptionRect
) -> WebDriverResult<()>

Set the current window rectangle, in pixels.

This requires an OptionRect, which is similar to Rect except all members are wrapped in Option.

Example:

use thirtyfour::OptionRect;
let r = OptionRect::new().with_size(1280, 720);
driver.set_window_rect(r).await?;

You can also convert from a Rect if you want to get the window size and modify it before setting it again.

use thirtyfour::OptionRect;
let rect = driver.get_window_rect().await?;
let option_rect = OptionRect::from(rect);
driver.set_window_rect(option_rect.with_width(1024)).await?;

pub async fn back<'_>(&'_ self) -> WebDriverResult<()>

Go back. This is equivalent to clicking the browser's back button.

Example:

driver.back().await?;

pub async fn forward<'_>(&'_ self) -> WebDriverResult<()>

Go forward. This is equivalent to clicking the browser's forward button.

Example:

driver.forward().await?;

pub async fn refresh<'_>(&'_ self) -> WebDriverResult<()>

Refresh the current page.

Example:

driver.refresh().await?;

pub async fn get_timeouts<'_>(&'_ self) -> WebDriverResult<TimeoutConfiguration>

Get all timeouts for the current session.

Example:

use thirtyfour::TimeoutConfiguration;
use std::time::Duration;
let timeouts = driver.get_timeouts().await?;
println!("Page load timeout = {:?}", timeouts.page_load());

pub async fn set_timeouts<'_>(
    &'_ self,
    timeouts: TimeoutConfiguration
) -> WebDriverResult<()>

Set all timeouts for the current session.

Example:

use thirtyfour::TimeoutConfiguration;
use std::time::Duration;
// Setting timeouts to None means those timeout values will not be updated.
let timeouts = TimeoutConfiguration::new(None, Some(Duration::new(11, 0)), None);
driver.set_timeouts(timeouts.clone()).await?;

pub async fn implicitly_wait<'_>(
    &'_ self,
    time_to_wait: Duration
) -> WebDriverResult<()>

Set the implicit wait timeout.

pub async fn set_script_timeout<'_>(
    &'_ self,
    time_to_wait: Duration
) -> WebDriverResult<()>

Set the script timeout.

pub async fn set_page_load_timeout<'_>(
    &'_ self,
    time_to_wait: Duration
) -> WebDriverResult<()>

Set the page load timeout.

pub fn action_chain(&self) -> ActionChain

Create a new action chain for this session.

Example:

let elem_text = driver.find_element(By::Name("input1")).await?;
let elem_button = driver.find_element(By::Id("button-set")).await?;

driver.action_chain()
    .send_keys_to_element(&elem_text, "thirtyfour")
    .move_to_element_center(&elem_button)
    .click()
    .perform().await?;

pub async fn get_cookies<'_>(&'_ self) -> WebDriverResult<Vec<Cookie>>

Get all cookies.

Example:

let cookies = driver.get_cookies().await?;
for cookie in &cookies {
    println!("Got cookie: {}", cookie.value());
}

pub async fn get_cookie<'_, '_>(
    &'_ self,
    name: &'_ str
) -> WebDriverResult<Cookie>

Get the specified cookie.

Example:

let cookie = driver.get_cookie("key").await?;
println!("Got cookie: {}", cookie.value());

pub async fn delete_cookie<'_, '_>(
    &'_ self,
    name: &'_ str
) -> WebDriverResult<()>

Delete the specified cookie.

Example:

driver.delete_cookie("key").await?;

pub async fn delete_all_cookies<'_>(&'_ self) -> WebDriverResult<()>

Delete all cookies.

Example:

driver.delete_all_cookies().await?;

pub async fn add_cookie<'_>(&'_ self, cookie: Cookie) -> WebDriverResult<()>

Add the specified cookie.

Example:

use thirtyfour::Cookie;

let cookie = Cookie::new("key", serde_json::json!("value"));
driver.add_cookie(cookie).await?;

pub async fn screenshot_as_base64<'_>(&'_ self) -> WebDriverResult<String>

Take a screenshot of the current window and return it as a base64-encoded String.

pub async fn screenshot_as_png<'_>(&'_ self) -> WebDriverResult<Vec<u8>>

Take a screenshot of the current window and return it as PNG bytes.

pub async fn screenshot<'_, '_>(&'_ self, path: &'_ Path) -> WebDriverResult<()>

Take a screenshot of the current window and write it to the specified filename.

pub fn switch_to(&self) -> SwitchTo

Return a SwitchTo struct for switching to another window or frame.

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 Drop for WebDriver

fn drop(&mut self)

Close the current session when the WebDriver struct goes out of scope.