Enum appium_client::find::By

pub enum By {
    Id(String),
    Name(String),
    Xpath(String),
    UiAutomator(String),
    AndroidDataMatcher(String),
    AndroidViewMatcher(String),
    AndroidViewTag(String),
    IosClassChain(String),
    IosNsPredicate(String),
    AccessibilityId(String),
    ClassName(String),
    Image(String),
    Custom(String),
    CustomKind(String, String),
}

Locators supported by Appium

If you wish to use your very own locator (e.g. something I didn’t implement in this enum), just use By::CustomKind.

Variants

Id(String)

Name(String)

Xpath(String)

UiAutomator(String)

AndroidDataMatcher(String)

AndroidViewMatcher(String)

AndroidViewTag(String)

IosClassChain(String)

IosNsPredicate(String)

AccessibilityId(String)

ClassName(String)

Image(String)

Custom(String)

CustomKind(String, String)

Implementations

impl By

pub fn id(id: &str) -> By

Native element identifier. resource-id for android; name for iOS.

pub fn name(name: &str) -> By

Name of element.

pub fn xpath(query: &str) -> By

Search the app XML source using xpath (not recommended, has performance issues).

pub fn uiautomator(query: &str) -> By

Use the UI Automator API, in particular the UiSelector class to locate elements. (UiAutomator2 only).

In Appium you send the Java code, as a string, to the server, which executes it in the application’s environment, returning the element or elements.

See https://developer.android.com/reference/androidx/test/uiautomator/UiSelector

pub fn android_data_matcher(query: &str) -> By

Locate an element using Espresso DataMatcher. (Espresso only)

pub fn android_view_matcher(query: &str) -> By

Locate an element using Espresso ViewMatcher. (Espresso only)

pub fn android_view_tag(query: &str) -> By

Locate an element by its view tag. (Espresso only)

pub fn ios_class_chain(query: &str) -> By

Locate an element by a class chain - a faster, but less powerful alternative to XPath on iOS.

pub fn ios_ns_predicate(query: &str) -> By

A string corresponding to a recursive element search using the iOS Predicate. (iOS 10.0 and above)

pub fn accessibility_id(id: &str) -> By

Read a unique identifier for a UI element.

For XCUITest it is the element’s accessibility-id attribute. For Android it is the element’s content-desc attribute.

pub fn class_name(class_name: &str) -> By

Locate element by its class name.

For IOS it is the full name of the XCUI element and begins with XCUIElementType. For Android it is the full name of the UIAutomator2 class (e.g.: android.widget.TextView)

pub fn image(base64_template: &str) -> By

Locate an element by matching it with a base 64 encoded image file

pub fn custom(query: &str) -> By

Custom locator for use with plugins registered via the customFindModules capability.

pub fn custom_kind(using: &str, value: &str) -> By

A locator for non-standard locators

You can define what type of locator to use, so you’re free to use anything here.

Trait Implementations

impl Clone for By

fn clone(&self) -> By

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for By

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

Formats the value using the given formatter.

impl From<By> for LocatorParameters

fn from(val: By) -> Self

Converts to this type from the input type.

impl PartialEq for By

fn eq(&self, other: &By) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for By

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for By