Struct GenericWebDriver 

pub struct GenericWebDriver<T: WebDriverHttpClientSync> {
    pub session: WebDriverSession,
    /* private fields */
}

NOTE: For WebDriver method documentation, see the WebDriverCommands trait.

The thirtyfour crate uses a generic struct that implements the WebDriverCommands trait. The generic struct is then implemented for a specific HTTP client.

This GenericWebDriver struct encapsulates a synchronous Selenium WebDriver browser session. For the async driver, see GenericWebDriver.

Example:

use thirtyfour_sync::prelude::*;

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

Fields

session: WebDriverSession

Implementations

impl<T> GenericWebDriver<T>

where T: WebDriverHttpClientSync + 'static,

pub fn new<C>(server_url: &str, capabilities: C) -> WebDriverResult<Self>

where C: Serialize,

The GenericWebDriver struct is not intended to be created directly.

Instead you would use the WebDriver struct, which wires up the GenericWebDriver with a HTTP client for making requests to the WebDriver server.

Create a new WebDriver as follows:

Example

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

NOTE: If the webdriver appears to hang or give no response, please check that the capabilities object is of the correct type for that webdriver.

pub fn new_with_timeout<C>( server_url: &str, capabilities: C, timeout: Option<Duration>, ) -> WebDriverResult<Self>

where C: Serialize,

Creates a new GenericWebDriver just like the new function. Allows a configurable timeout for all HTTP requests including the session creation.

Create a new WebDriver as follows:

Example

let caps = DesiredCapabilities::chrome();
let driver = WebDriver::new_with_timeout("http://localhost:4444/wd/hub", &caps, Some(Duration::from_secs(120)))?;

pub fn capabilities(&self) -> DesiredCapabilities

Return a clone of the capabilities as returned by Selenium.

pub fn session_id(&self) -> &SessionId

pub fn config(&self) -> &WebDriverConfig

pub fn config_mut(&mut self) -> &mut WebDriverConfig

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

End the webdriver session.

pub fn set_request_timeout(&mut self, timeout: Duration) -> WebDriverResult<()>

Set the request timeout for the HTTP client.

Example

let caps = DesiredCapabilities::chrome();
let mut driver = WebDriver::new("http://localhost:4444/wd/hub", &caps)?;
driver.set_request_timeout(Duration::from_secs(180))?;

impl<T> GenericWebDriver<T>

where T: WebDriverHttpClientSync + 'static,

pub fn set_query_poller(&mut self, poller: ElementPoller)

Trait Implementations

impl<T: Debug + WebDriverHttpClientSync> Debug for GenericWebDriver<T>

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

Formats the value using the given formatter.

impl<T> Drop for GenericWebDriver<T>

where T: WebDriverHttpClientSync,

fn drop(&mut self)

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

impl<T> WebDriverCommands for GenericWebDriver<T>

where T: WebDriverHttpClientSync,

fn session(&self) -> &WebDriverSession

Get the current session and http client.

fn cmd(&self, command: Command) -> WebDriverResult<Value>

Convenience wrapper for running WebDriver commands.

fn close(&self) -> WebDriverResult<()>

Close the current window or tab.

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

Navigate to the specified URL.

fn current_url(&self) -> WebDriverResult<String>

Get the current URL as a String.

fn page_source(&self) -> WebDriverResult<String>

Get the page source as a String.

fn title(&self) -> WebDriverResult<String>

Get the page title as a String.

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

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

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

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

fn execute_script(&self, script: &str) -> WebDriverResult<ScriptRetSync<'_>>

Execute the specified Javascript synchronously and return the result.

fn execute_script_with_args( &self, script: &str, args: &ScriptArgs, ) -> WebDriverResult<ScriptRetSync<'_>>

Execute the specified Javascript synchronously and return the result.

fn execute_async_script( &self, script: &str, ) -> WebDriverResult<ScriptRetSync<'_>>

Execute the specified Javascrypt asynchronously and return the result.

fn execute_async_script_with_args( &self, script: &str, args: &ScriptArgs, ) -> WebDriverResult<ScriptRetSync<'_>>

Execute the specified Javascrypt asynchronously and return the result.

fn current_window_handle(&self) -> WebDriverResult<WindowHandle>

Get the current window handle.

fn window_handles(&self) -> WebDriverResult<Vec<WindowHandle>>

Get all window handles for the current session.

fn maximize_window(&self) -> WebDriverResult<()>

Maximize the current window.

fn minimize_window(&self) -> WebDriverResult<()>

Minimize the current window.

fn fullscreen_window(&self) -> WebDriverResult<()>

Make the current window fullscreen.

fn get_window_rect(&self) -> WebDriverResult<Rect>

Get the current window rectangle, in pixels.

fn set_window_rect(&self, rect: OptionRect) -> WebDriverResult<()>

Set the current window rectangle, in pixels.

fn back(&self) -> WebDriverResult<()>

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

fn forward(&self) -> WebDriverResult<()>

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

fn refresh(&self) -> WebDriverResult<()>

Refresh the current page.

fn get_timeouts(&self) -> WebDriverResult<TimeoutConfiguration>

Get all timeouts for the current session.

fn set_timeouts(&self, timeouts: TimeoutConfiguration) -> WebDriverResult<()>

Set all timeouts for the current session.

fn set_implicit_wait_timeout( &self, time_to_wait: Duration, ) -> WebDriverResult<()>

Set the implicit wait timeout. This is how long the WebDriver will wait when querying elements.

fn set_script_timeout(&self, time_to_wait: Duration) -> WebDriverResult<()>

Set the script timeout. This is how long the WebDriver will wait for a Javascript script to execute.

fn set_page_load_timeout(&self, time_to_wait: Duration) -> WebDriverResult<()>

Set the page load timeout. This is how long the WebDriver will wait for the page to finish loading.

fn action_chain(&self) -> ActionChain<'_>

Create a new action chain for this session. Action chains can be used to simulate more complex user input actions involving key combinations, mouse movements, mouse click, right-click, and more.

fn get_cookies(&self) -> WebDriverResult<Vec<Cookie>>

Get all cookies.

fn get_cookie(&self, name: &str) -> WebDriverResult<Cookie>

Get the specified cookie.

fn delete_cookie(&self, name: &str) -> WebDriverResult<()>

Delete the specified cookie.

fn delete_all_cookies(&self) -> WebDriverResult<()>

Delete all cookies.

fn add_cookie(&self, cookie: Cookie) -> WebDriverResult<()>

Add the specified cookie.

fn screenshot_as_base64(&self) -> WebDriverResult<String>

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

fn screenshot_as_png(&self) -> WebDriverResult<Vec<u8>>

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

fn screenshot(&self, path: &Path) -> WebDriverResult<()>

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.

fn set_window_name(&self, window_name: &str) -> WebDriverResult<()>

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

fn extension_command<T: ExtensionCommand + Send + Sync + 'static>( &self, ext_cmd: T, ) -> WebDriverResult<Value>

Running an extension command. Extension commands are browser specific commands and using browser specific endpoints and parameters.

fn in_new_tab<F, T>(&self, f: F) -> WebDriverResult<T>

where F: FnOnce() -> WebDriverResult<T>,

Execute the specified function in a new browser tab, closing the tab when complete. The return value will be that of the supplied function, unless an error occurs while opening or closing the tab.