Struct thirtyfour_sync::WebElement

pub struct WebElement<'a> {
    pub element_id: ElementId,
    // some fields omitted
}

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"))?;

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']"))?;
let child_elem = elem.find_element(By::Tag("button"))?;

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

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 fn rect(&self) -> WebDriverResult<ElementRect>

Get the bounding rectangle for this WebElement.

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

Get the tag name for this WebElement.

Example:

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

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

Get the class name for this WebElement.

Example:

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

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

Get the id for this WebElement.

Example:

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

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

Get the text contents for this WebElement.

Example:

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

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

Convenience method for getting the value attribute of this element.

pub fn click(&self) -> WebDriverResult<()>

Click the WebElement.

Example:

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

pub fn clear(&self) -> WebDriverResult<()>

Clear the WebElement contents.

Example:

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

Get the specified property.

Example:

let bool_value = elem.get_property("checked")?;
assert_eq!(bool_value, "true");
let string_value = elem.get_property("name")?;
assert_eq!(string_value, "input2");

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

Get the specified attribute.

Example:

let attribute = elem.get_attribute("name")?;
assert_eq!(attribute, "input2");

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

Get the specified CSS property.

Example:

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

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

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

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

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

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

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']"))?;
let child_elem = elem.find_element(By::Tag("button"))?;

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

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']"))?;
let child_elems = elem.find_elements(By::Tag("button"))?;
for child_elem in child_elems {
    assert_eq!(child_elem.tag_name()?, "button");
}

pub 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")?;

You can also send special key combinations like this:

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

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

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

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

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

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

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

pub fn focus(&self) -> WebDriverResult<()>

Focus this WebElement using JavaScript.

Example:

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

pub fn scroll_into_view(&self) -> WebDriverResult<()>

Scroll this element into view using JavaScript.

Example:

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

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

Get the innerHtml property of this element.

Example:

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

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

Get the outerHtml property of this element.

Example:

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

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.