Struct thirtyfour::WebElement

pub struct WebElement<'a> {
    pub element_id: ElementId,
    pub session: &'a WebDriverSession,
}

The WebElement struct encapsulates a single element on a page.

WebElement structs are generally not constructed manually, but rather they are returned from a 'find_element()' operation using a WebDriver.

Example:

let elem = driver.find_element(By::Id("input-result")).await?;

You can also search for a child element of another element as follows:

let elem = driver.find_element(By::Css("div[data-section='section-buttons']")).await?;
let child_elem = elem.find_element(By::Tag("button")).await?;

Elements can be clicked using the click() method, and you can send input to an element using the send_keys() method.

Fields

element_id: ElementId

session: &'a WebDriverSession

Implementations

impl<'a> WebElement<'a>

pub fn new(session: &'a WebDriverSession, element_id: ElementId) -> Self

Create a new WebElement struct.

Typically you would not call this directly. WebElement structs are usually constructed by calling one of the find_element*() methods either on WebDriver or another WebElement.

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

Get the bounding rectangle for this WebElement.

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

Get the tag name for this WebElement.

Example:

let elem = driver.find_element(By::Id("button1")).await?;
assert_eq!(elem.tag_name().await?, "button");

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

Get the class name for this WebElement.

Example:

let elem = driver.find_element(By::Id("button1")).await?;
let class_name = elem.class_name().await?;

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

Get the id for this WebElement.

Example:

let elem = driver.find_element(By::Id("button1")).await?;
let id = elem.id().await?;

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

Get the text contents for this WebElement.

Example:

let elem = driver.find_element(By::Id("button-result")).await?;
let text = elem.text().await?;

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

Convenience method for getting the value attribute of this element.

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

Click the WebElement.

Example:

let elem = driver.find_element(By::Id("button1")).await?;
elem.click().await?;

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

Clear the WebElement contents.

Example:

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

Get the specified property.

Example:

let property_value = elem.get_property("checked").await?;
assert_eq!(property_value, "true");

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

Get the specified attribute.

Example:

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

Get the specified CSS property.

Example:

let css_color = elem.get_css_property("color").await?;
assert_eq!(css_color, "rgba(0, 0, 0, 1)");

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

Return true if the WebElement is currently selected, otherwise false.

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

Return true if the WebElement is currently enabled, otherwise false.

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

Search for a child element of this WebElement using the specified selector.

Example:

let elem = driver.find_element(By::Css("div[data-section='section-buttons']")).await?;
let child_elem = elem.find_element(By::Tag("button")).await?;

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

Search for all child elements of this WebElement that match the specified selector.

Example:

let elem = driver.find_element(By::Css("div[data-section='section-buttons']")).await?;
let child_elems = elem.find_elements(By::Tag("button")).await?;
for child_elem in child_elems {
    assert_eq!(child_elem.tag_name().await?, "button");
}

pub async fn send_keys<S, '_>(&'_ self, keys: S) -> WebDriverResult<()> where
    S: Into<TypingData>, 

Send the specified input.

Example:

You can specify anything that implements Into<TypingData>. This includes &str and String.

elem.send_keys("selenium").await?;

You can also send special key combinations like this:

elem.send_keys("selenium").await?;
elem.send_keys(Keys::Control + "a").await?;
elem.send_keys(TypingData::from("thirtyfour") + Keys::Enter).await?;

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

Take a screenshot of this WebElement and return it as a base64-encoded String.

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

Take a screenshot of this WebElement and return it as PNG bytes.

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

Take a screenshot of this WebElement and write it to the specified filename.

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

Focus this WebElement using JavaScript.

Example:

let elem = driver.find_element(By::Name("input1")).await?;
elem.focus().await?;

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

Scroll this element into view using JavaScript.

Example:

let elem = driver.find_element(By::Id("button1")).await?;
elem.scroll_into_view().await?;

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

Get the innerHtml property of this element.

Example:

let elem = driver.find_element(By::XPath(r##"//*[@id="button1"]/.."##)).await?;
let html = elem.inner_html().await?;

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

Get the outerHtml property of this element.

Example:

let elem = driver.find_element(By::XPath(r##"//*[@id="button1"]/.."##)).await?;
let html = elem.outer_html().await?;

Trait Implementations

impl<'a> Clone for WebElement<'a>

fn clone(&self) -> WebElement<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for WebElement<'a>

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

Formats the value using the given formatter.

impl<'a> Display for WebElement<'a>

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

Formats the value using the given formatter.

impl<'a> Serialize for WebElement<'a>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.