Struct thirtyfour::WebDriver

pub struct WebDriver {
    pub session_id: SessionId,
    // some fields omitted
}

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

See the WebDriverCommands trait for WebDriver methods.

Example:

use thirtyfour::prelude::*;
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(())
}

Fields

session_id: SessionId

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.

Trait Implementations

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.

impl WebDriverCommands for WebDriver

fn cmd<'life0, 'life1, 'async_trait>(
    &'life0 self,
    command: Command<'life1>
) -> Pin<Box<dyn Future<Output = WebDriverResult<Value>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Convenience wrapper for running WebDriver commands.

fn session(&self) -> WebDriverSession

Get the current session and connection.

#[must_use]fn close<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = WebDriverResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Close the current window.

#[must_use]fn quit<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = WebDriverResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

End the webdriver session.

#[must_use]fn get<'life0, 'async_trait, S: Into<String> + Send>(
    &'life0 self,
    url: S
) -> Pin<Box<dyn Future<Output = WebDriverResult<()>> + Send + 'async_trait>> where
    S: 'async_trait,
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Navigate to the specified URL.

#[must_use]fn current_url<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = WebDriverResult<String>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Get the current URL as a String.

#[must_use]fn page_source<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = WebDriverResult<String>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Get the page source as a String.

#[must_use]fn title<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = WebDriverResult<String>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Get the page title as a String.

#[must_use]fn find_element<'b, 'life0, 'async_trait>(
    &'b self,
    by: By<'life0>
) -> Pin<Box<dyn Future<Output = WebDriverResult<WebElement<'b>>> + Send + 'async_trait>> where
    'b: 'async_trait,
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

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

#[must_use]fn find_elements<'b, 'life0, 'async_trait>(
    &'b self,
    by: By<'life0>
) -> Pin<Box<dyn Future<Output = WebDriverResult<Vec<WebElement<'b>>>> + Send + 'async_trait>> where
    'b: 'async_trait,
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

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

#[must_use]fn execute_script<'b, 'life0, 'async_trait>(
    &'b self,
    script: &'life0 str
) -> Pin<Box<dyn Future<Output = WebDriverResult<ScriptRet<'b>>> + Send + 'async_trait>> where
    'b: 'async_trait,
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Execute the specified Javascript synchronously and return the result.

#[must_use]fn execute_script_with_args<'b, 'life0, 'life1, 'async_trait>(
    &'b self,
    script: &'life0 str,
    args: &'life1 ScriptArgs
) -> Pin<Box<dyn Future<Output = WebDriverResult<ScriptRet<'b>>> + Send + 'async_trait>> where
    'b: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: Sync + 'async_trait, 

Execute the specified Javascript synchronously and return the result.

#[must_use]fn execute_async_script<'b, 'life0, 'async_trait>(
    &'b self,
    script: &'life0 str
) -> Pin<Box<dyn Future<Output = WebDriverResult<ScriptRet<'b>>> + Send + 'async_trait>> where
    'b: 'async_trait,
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Execute the specified Javascrypt asynchronously and return the result.

#[must_use]fn execute_async_script_with_args<'b, 'life0, 'life1, 'async_trait>(
    &'b self,
    script: &'life0 str,
    args: &'life1 ScriptArgs
) -> Pin<Box<dyn Future<Output = WebDriverResult<ScriptRet<'b>>> + Send + 'async_trait>> where
    'b: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: Sync + 'async_trait, 

Execute the specified Javascrypt asynchronously and return the result.

#[must_use]fn current_window_handle<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = WebDriverResult<WindowHandle>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Get the current window handle.

#[must_use]fn window_handles<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = WebDriverResult<Vec<WindowHandle>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Get all window handles for the current session.

#[must_use]fn maximize_window<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = WebDriverResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Maximize the current window.

#[must_use]fn minimize_window<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = WebDriverResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Minimize the current window.

#[must_use]fn fullscreen_window<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = WebDriverResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Make the current window fullscreen.

#[must_use]fn get_window_rect<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = WebDriverResult<Rect>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Get the current window rectangle, in pixels.

#[must_use]fn set_window_rect<'life0, 'async_trait>(
    &'life0 self,
    rect: OptionRect
) -> Pin<Box<dyn Future<Output = WebDriverResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Set the current window rectangle, in pixels.

#[must_use]fn back<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = WebDriverResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

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

#[must_use]fn forward<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = WebDriverResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

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

#[must_use]fn refresh<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = WebDriverResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Refresh the current page.

#[must_use]fn get_timeouts<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = WebDriverResult<TimeoutConfiguration>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Get all timeouts for the current session.

#[must_use]fn set_timeouts<'life0, 'async_trait>(
    &'life0 self,
    timeouts: TimeoutConfiguration
) -> Pin<Box<dyn Future<Output = WebDriverResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Set all timeouts for the current session.

#[must_use]fn implicitly_wait<'life0, 'async_trait>(
    &'life0 self,
    time_to_wait: Duration
) -> Pin<Box<dyn Future<Output = WebDriverResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Set the implicit wait timeout.

#[must_use]fn set_script_timeout<'life0, 'async_trait>(
    &'life0 self,
    time_to_wait: Duration
) -> Pin<Box<dyn Future<Output = WebDriverResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Set the script timeout.

#[must_use]fn set_page_load_timeout<'life0, 'async_trait>(
    &'life0 self,
    time_to_wait: Duration
) -> Pin<Box<dyn Future<Output = WebDriverResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Set the page load timeout.

fn action_chain(&self) -> ActionChain

Create a new action chain for this session.

#[must_use]fn get_cookies<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = WebDriverResult<Vec<Cookie>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Get all cookies.

#[must_use]fn get_cookie<'life0, 'life1, 'async_trait>(
    &'life0 self,
    name: &'life1 str
) -> Pin<Box<dyn Future<Output = WebDriverResult<Cookie>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: Sync + 'async_trait, 

Get the specified cookie.

#[must_use]fn delete_cookie<'life0, 'life1, 'async_trait>(
    &'life0 self,
    name: &'life1 str
) -> Pin<Box<dyn Future<Output = WebDriverResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: Sync + 'async_trait, 

Delete the specified cookie.

#[must_use]fn delete_all_cookies<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = WebDriverResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Delete all cookies.

#[must_use]fn add_cookie<'life0, 'async_trait>(
    &'life0 self,
    cookie: Cookie
) -> Pin<Box<dyn Future<Output = WebDriverResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

Add the specified cookie.

#[must_use]fn screenshot_as_base64<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = WebDriverResult<String>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

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

#[must_use]fn screenshot_as_png<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = WebDriverResult<Vec<u8>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: Sync + 'async_trait, 

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

#[must_use]fn screenshot<'life0, 'life1, 'async_trait>(
    &'life0 self,
    path: &'life1 Path
) -> Pin<Box<dyn Future<Output = WebDriverResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: Sync + 'async_trait, 

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

fn switch_to(&self) -> SwitchTo

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

#[must_use]fn set_window_name<'life0, 'life1, 'async_trait>(
    &'life0 self,
    window_name: &'life1 str
) -> Pin<Box<dyn Future<Output = WebDriverResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: Sync + 'async_trait, 

Set the current window name. Useful for switching between windows/tabs using driver.switch_to().window_name(name).