Struct thirtyfour::WebDriverSession

pub struct WebDriverSession { /* fields omitted */ }

Implementations

impl WebDriverSession

pub fn new(
    session_id: SessionId,
    conn: Arc<dyn WebDriverHttpClientAsync>
) -> Self

pub fn session_id(&self) -> &SessionId

pub fn config(&self) -> &WebDriverConfig

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

pub async fn execute<'_, '_>(
    &'_ self,
    command: Command<'_>
) -> WebDriverResult<Value>

Trait Implementations

impl Debug for WebDriverSession

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

Formats the value using the given formatter.

impl WebDriverCommands for WebDriverSession

fn session(&self) -> &WebDriverSession

Get the current session and http client.

#[must_use]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: Sync + 'async_trait, 

Convenience wrapper for running WebDriver commands.

#[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 or tab.

#[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<'a, 'life0, 'async_trait>(
    &'a self,
    by: By<'life0>
) -> Pin<Box<dyn Future<Output = WebDriverResult<WebElement<'a>>> + Send + 'async_trait>> where
    'a: '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<'a, 'life0, 'async_trait>(
    &'a self,
    by: By<'life0>
) -> Pin<Box<dyn Future<Output = WebDriverResult<Vec<WebElement<'a>>>> + Send + 'async_trait>> where
    'a: '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<'a, 'life0, 'async_trait>(
    &'a self,
    script: &'life0 str
) -> Pin<Box<dyn Future<Output = WebDriverResult<ScriptRet<'a>>> + Send + 'async_trait>> where
    'a: '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<'a, 'life0, 'life1, 'async_trait>(
    &'a self,
    script: &'life0 str,
    args: &'life1 ScriptArgs
) -> Pin<Box<dyn Future<Output = WebDriverResult<ScriptRet<'a>>> + Send + 'async_trait>> where
    'a: '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<'a, 'life0, 'async_trait>(
    &'a self,
    script: &'life0 str
) -> Pin<Box<dyn Future<Output = WebDriverResult<ScriptRet<'a>>> + Send + 'async_trait>> where
    'a: '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<'a, 'life0, 'life1, 'async_trait>(
    &'a self,
    script: &'life0 str,
    args: &'life1 ScriptArgs
) -> Pin<Box<dyn Future<Output = WebDriverResult<ScriptRet<'a>>> + Send + 'async_trait>> where
    'a: '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 set_implicit_wait_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 implicit wait timeout. This is how long the WebDriver will wait when querying elements.

#[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. This is how long the WebDriver will wait for a Javascript script to execute.

#[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. 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.

#[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).

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

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