Skip to main content

Selectors

Struct Selectors 

Source
pub struct Selectors { /* private fields */ }
Expand description

Selectors — manages custom selector engines and test ID attribute configuration.

An instance of Selectors is available via crate::protocol::Playwright::selectors().

Selector engines registered here are applied to all browser contexts. Register engines before creating pages that will use them.

See: https://playwright.dev/docs/api/class-selectors

Implementations§

Source§

impl Selectors

Source

pub fn new() -> Self

Creates a new, empty Selectors coordinator.

Source

pub async fn add_context(&self, channel: Channel) -> Result<()>

Registers a context’s channel so it receives selector updates.

Called by BrowserContext when it is created, so that:

  1. All previously registered engines are applied to it immediately.
  2. Future register() / set_test_id_attribute() calls reach it.
Source

pub fn remove_context(&self, channel: &Channel)

Removes a context’s channel when it is closed.

Called by BrowserContext on close to avoid sending messages to dead channels.

Source

pub async fn register( &self, name: &str, script: &str, content_script: Option<bool>, ) -> Result<()>

Registers a custom selector engine.

The script must evaluate to an object with query and queryAll methods:

{
    query(root, selector) { return root.querySelector(selector); },
    queryAll(root, selector) { return Array.from(root.querySelectorAll(selector)); }
}

After registration, use the engine with page.locator("name=selector").

§Arguments
  • name - Name to assign to the selector engine.
  • script - JavaScript string that evaluates to a selector engine factory.
  • content_script - Whether to run the engine in isolated content script mode. Defaults to false.
§Errors

Returns error if:

  • A selector engine with the same name is already registered
  • Any context rejects the registration (invalid script, etc.)

See: https://playwright.dev/docs/api/class-selectors#selectors-register

Source

pub fn test_id_attribute(&self) -> String

Returns the current test ID attribute name used by get_by_test_id() locators.

Defaults to "data-testid".

Source

pub async fn set_test_id_attribute(&self, attribute: &str) -> Result<()>

Sets the attribute used by get_by_test_id() locators.

By default, Playwright uses data-testid. Calling this method changes the attribute name for all current and future contexts.

§Arguments
  • attribute - The attribute name to use as the test ID (e.g., "data-custom-id").
§Errors

Returns error if any context rejects the update.

See: https://playwright.dev/docs/api/class-selectors#selectors-set-test-id-attribute

Trait Implementations§

Source§

impl Clone for Selectors

Source§

fn clone(&self) -> Selectors

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Selectors

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Selectors

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more