Struct ElementWaiter

pub struct ElementWaiter { /* private fields */ }

High-level interface for performing explicit waits using the builder pattern.

Example:

let elem = driver.query(By::Id("button1")).first().await?;
// Wait until the element is displayed.
elem.wait_until().displayed().await?;

Implementations

impl ElementWaiter

pub fn new( element: WebElement, poller: Arc<dyn IntoElementPoller + Send + Sync>, ) -> Self

Create a new ElementWaiter.

See Element::wait_until() rather than creating this directly.

pub fn with_poller( self, poller: Arc<dyn IntoElementPoller + Send + Sync>, ) -> Self

Use the specified ElementPoller for this ElementWaiter. This will not affect the default ElementPoller used for other waits.

pub fn error(self, message: &str) -> Self

Provide a human-readable error message to be returned in the case of timeout.

pub fn ignore_errors(self, ignore: bool) -> Self

By default, a waiter will ignore any errors that occur while polling for the desired condition(s). However, this behaviour can be modified so that the waiter will return early if an error is returned from thirtyfour.

pub fn wait(self, timeout: Duration, interval: Duration) -> Self

Force this ElementWaiter to wait for the specified timeout, polling once after each interval. This will override the poller for this ElementWaiter only.

pub async fn condition(self, f: impl ElementPredicate) -> WebDriverResult<()>

Wait for the specified condition to be true.

pub async fn conditions( self, conditions: Vec<Box<DynElementPredicate>>, ) -> WebDriverResult<()>

Wait for the specified conditions to be true.

pub async fn stale(self) -> WebDriverResult<()>

Wait for the element to become stale.

pub async fn displayed(self) -> WebDriverResult<()>

Wait for the element to be displayed.

pub async fn not_displayed(self) -> WebDriverResult<()>

Wait for the element to not be displayed.

pub async fn selected(self) -> WebDriverResult<()>

Wait for the element to be selected.

pub async fn not_selected(self) -> WebDriverResult<()>

Wait for the element to not be selected.

pub async fn enabled(self) -> WebDriverResult<()>

Wait for the element to be enabled.

pub async fn not_enabled(self) -> WebDriverResult<()>

Wait for the element to not be enabled.

pub async fn clickable(self) -> WebDriverResult<()>

Wait for the element to be clickable.

pub async fn not_clickable(self) -> WebDriverResult<()>

Wait for the element to not be clickable.

pub async fn has_class<N>(self, class_name: N) -> WebDriverResult<()>

where N: Needle + Clone + Send + Sync + 'static,

Wait until the element has the specified class.

pub async fn lacks_class<N>(self, class_name: N) -> WebDriverResult<()>

where N: Needle + Clone + Send + Sync + 'static,

Wait until the element lacks the specified class.

pub async fn has_text<N>(self, text: N) -> WebDriverResult<()>

where N: Needle + Clone + Send + Sync + 'static,

Wait until the element has the specified text.

pub async fn lacks_text<N>(self, text: N) -> WebDriverResult<()>

where N: Needle + Clone + Send + Sync + 'static,

Wait until the element lacks the specified text.

pub async fn has_value<N>(self, value: N) -> WebDriverResult<()>

where N: Needle + Clone + Send + Sync + 'static,

Wait until the element has the specified value.

pub async fn lacks_value<N>(self, value: N) -> WebDriverResult<()>

where N: Needle + Clone + Send + Sync + 'static,

Wait until the element lacks the specified value.

pub async fn has_attribute<S, N>( self, attribute_name: S, value: N, ) -> WebDriverResult<()>

where S: IntoArcStr, N: Needle + Clone + Send + Sync + 'static,

Wait until the element has the specified attribute.

pub async fn lacks_attribute<S, N>( self, attribute_name: S, value: N, ) -> WebDriverResult<()>

where S: IntoArcStr, N: Needle + Clone + Send + Sync + 'static,

Wait until the element lacks the specified attribute.

pub async fn has_attributes<S, N>( self, desired_attributes: impl IntoIterator<Item = (S, N)>, ) -> WebDriverResult<()>

where S: IntoArcStr, N: Needle + Send + Sync + 'static,

Wait until the element has all the specified attributes.

pub async fn lacks_attributes<S, N>( self, desired_attributes: impl IntoIterator<Item = (S, N)>, ) -> WebDriverResult<()>

where S: IntoArcStr, N: Needle + Send + Sync + 'static,

Wait until the element lacks all the specified attributes.

pub async fn has_property<S, N>( self, property_name: S, value: N, ) -> WebDriverResult<()>

where S: IntoArcStr, N: Needle + Clone + Send + Sync + 'static,

Wait until the element has the specified property.

pub async fn lacks_property<S, N>( self, property_name: S, value: N, ) -> WebDriverResult<()>

where S: IntoArcStr, N: Needle + Clone + Send + Sync + 'static,

Wait until the element lacks the specified property.

pub async fn has_properties<S, N>( self, desired_properties: impl IntoIterator<Item = (S, N)>, ) -> WebDriverResult<()>

where S: IntoArcStr, N: Needle + Send + Sync + 'static,

Wait until the element has all the specified properties.

pub async fn lacks_properties<S, N>( self, desired_properties: impl IntoIterator<Item = (S, N)>, ) -> WebDriverResult<()>

where S: IntoArcStr, N: Needle + Send + Sync + 'static,

Wait until the element lacks all the specified properties.

pub async fn has_css_property<S, N>( self, css_property_name: S, value: N, ) -> WebDriverResult<()>

where S: IntoArcStr, N: Needle + Clone + Send + Sync + 'static,

Wait until the element has the specified CSS property.

pub async fn lacks_css_property<S, N>( self, css_property_name: S, value: N, ) -> WebDriverResult<()>

where S: IntoArcStr, N: Needle + Clone + Send + Sync + 'static,

Wait until the element lacks the specified CSS property.

pub async fn has_css_properties<S, N>( self, desired_css_properties: impl IntoIterator<Item = (S, N)>, ) -> WebDriverResult<()>

where S: IntoArcStr, N: Needle + Send + Sync + 'static,

Wait until the element has all the specified CSS properties.

pub async fn lacks_css_properties<S, N>( self, desired_css_properties: impl IntoIterator<Item = (S, N)>, ) -> WebDriverResult<()>

where S: IntoArcStr, N: Needle + Send + Sync + 'static,

Wait until the element lacks all the specified CSS properties.

Trait Implementations

impl Debug for ElementWaiter

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

Formats the value using the given formatter.