Keyboard

Struct Keyboard 

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

Keyboard controller for direct keyboard input.

Provides methods for pressing keys, typing text, and managing modifier state.

§Example

// Press a single key
page.keyboard().press("Enter").await?;

// Type text character by character
page.keyboard().type_text("Hello").await?;

// Use key combinations
page.keyboard().press("Control+a").await?;

// Hold modifier and press keys
page.keyboard().down("Shift").await?;
page.keyboard().press("a").await?; // Types 'A'
page.keyboard().up("Shift").await?;

Implementations§

Source§

impl Keyboard

Source

pub async fn press(&self, key: &str) -> Result<(), LocatorError>

Press and release a key or key combination.

§Arguments
  • key - Key to press. Can be:
    • A single key: "Enter", "a", "F1"
    • A key combination: "Control+c", "Shift+Tab"
    • ControlOrMeta for cross-platform shortcuts
§Example
page.keyboard().press("Enter").await?;
page.keyboard().press("Control+a").await?;
page.keyboard().press("ControlOrMeta+c").await?;
Source

pub async fn press_with_delay( &self, key: &str, delay: Option<Duration>, ) -> Result<(), LocatorError>

Press and release a key with a delay between down and up.

Source

pub async fn down(&self, key: &str) -> Result<(), LocatorError>

Press and hold a key.

The key will remain pressed until up() is called.

§Example
page.keyboard().down("Shift").await?;
page.keyboard().press("a").await?; // Types 'A'
page.keyboard().up("Shift").await?;
Source

pub async fn up(&self, key: &str) -> Result<(), LocatorError>

Release a held key.

§Example
page.keyboard().down("Shift").await?;
// ... do stuff with Shift held
page.keyboard().up("Shift").await?;
Source

pub async fn type_text(&self, text: &str) -> Result<(), LocatorError>

Type text character by character with key events.

This generates individual key events for each character. Use insert_text() for faster text entry without key events.

§Example
page.keyboard().type_text("Hello, World!").await?;
Source

pub async fn type_text_with_delay( &self, text: &str, delay: Option<Duration>, ) -> Result<(), LocatorError>

Type text with a delay between each character.

Source

pub async fn insert_text(&self, text: &str) -> Result<(), LocatorError>

Insert text directly without generating key events.

This is faster than type_text() and works with non-ASCII characters. No keydown/keyup events are dispatched.

§Example
page.keyboard().insert_text("Hello 👋 你好").await?;

Trait Implementations§

Source§

impl Debug for Keyboard

Source§

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

Formats the value using the given formatter. 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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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