Struct GetByRoleOptions 

#[non_exhaustive]
pub struct GetByRoleOptions {
    pub checked: Option<bool>,
    pub disabled: Option<bool>,
    pub selected: Option<bool>,
    pub expanded: Option<bool>,
    pub include_hidden: Option<bool>,
    pub level: Option<u32>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub exact: Option<bool>,
    pub pressed: Option<bool>,
}

Options for get_by_role() locator.

All fields are optional. When not specified, the property is not included in the role selector, meaning it matches any value.

See: https://playwright.dev/docs/api/class-page#page-get-by-role

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

checked: Option<bool>

Whether the element is checked (for checkboxes, radio buttons).

disabled: Option<bool>

Whether the element is disabled.

selected: Option<bool>

Whether the element is selected (for options).

expanded: Option<bool>

Whether the element is expanded (for tree items, comboboxes).

include_hidden: Option<bool>

Whether to include hidden elements.

level: Option<u32>

The heading level (1-6, for heading role).

name: Option<String>

The accessible name of the element.

description: Option<String>

The accessible description of the element (WAI-ARIA), matched in addition to role/name. Honors exact like name.

exact: Option<bool>

Whether name/description matching is exact (case-sensitive, full-string). Default is false (case-insensitive substring).

pressed: Option<bool>

Whether the element is pressed (for toggle buttons).

Implementations

impl GetByRoleOptions

pub fn checked(self, checked: bool) -> Self

Match only checked / unchecked elements.

pub fn disabled(self, disabled: bool) -> Self

Match only enabled / disabled elements.

pub fn selected(self, selected: bool) -> Self

Match only selected / unselected elements.

pub fn expanded(self, expanded: bool) -> Self

Match only expanded / collapsed elements.

pub fn include_hidden(self, include_hidden: bool) -> Self

Include elements normally excluded from the accessibility tree.

pub fn level(self, level: u32) -> Self

Match the aria-level (e.g. heading level).

pub fn name(self, name: impl Into<String>) -> Self

Match the accessible name.

pub fn description(self, description: impl Into<String>) -> Self

Match the accessible description.

pub fn exact(self, exact: bool) -> Self

Whether name/description match exactly (case-sensitive whole string).

pub fn pressed(self, pressed: bool) -> Self

Match only pressed / unpressed elements.

Trait Implementations

impl Clone for GetByRoleOptions

fn clone(&self) -> GetByRoleOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetByRoleOptions

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

Formats the value using the given formatter.

impl Default for GetByRoleOptions

fn default() -> GetByRoleOptions

Returns the “default value” for a type.