Skip to main content

ClickOptions

Struct ClickOptions 

Source
pub struct ClickOptions {
    pub button: Option<MouseButton>,
    pub click_count: Option<u32>,
    pub delay: Option<u64>,
    pub force: Option<bool>,
    pub modifiers: Vec<Modifier>,
    pub no_wait_after: Option<bool>,
    pub position: Option<Point>,
    pub steps: Option<u32>,
    pub timeout: Option<u64>,
    pub trial: Option<bool>,
}
Expand description

Full click option bag shared by Page/Locator/Frame click methods. All three expose the same 10-field surface.

Every option is Option<T>: callers omit fields and the backend applies the documented defaults (button: Left, click_count: 1, delay: 0, steps: 1, etc.).

Fields§

§button: Option<MouseButton>

Mouse button. Default: MouseButton::Left.

§click_count: Option<u32>

Number of consecutive clicks (UIEvent.detail). Default: 1.

§delay: Option<u64>

Wait in ms between mousedown and mouseup. Default: 0.

§force: Option<bool>

Bypass actionability (visibility/attached/enabled/stable) checks. Default: false.

§modifiers: Vec<Modifier>

Modifier keys held during the click. Pressed before the mouse events and released after, regardless of trial.

§no_wait_after: Option<bool>

Deprecated — accepted for signature parity; no effect in ferridriver (we don’t implicitly wait for navigation after click).

§position: Option<Point>

Click position relative to the element’s padding-box top-left. None → element’s visible center.

§steps: Option<u32>

Interpolated mousemove events between the current cursor and the click point. Default: 1 (single move at dest).

§timeout: Option<u64>

Maximum time in ms for the operation (actionability + click). 0 means “no timeout”. None means “use page/context default”.

§trial: Option<bool>

Run actionability checks only; skip the mouse events. Modifiers are still pressed/released around the no-op.

Implementations§

Source§

impl ClickOptions

Source

pub fn resolved_button(&self) -> MouseButton

Self::button with the Left default applied.

Source

pub fn resolved_click_count(&self) -> u32

Self::click_count with the 1 default applied.

Source

pub fn resolved_delay_ms(&self) -> u64

Self::delay with the 0ms default applied.

Source

pub fn resolved_steps(&self) -> u32

Self::steps with the 1 default applied.

Source

pub fn is_force(&self) -> bool

true when the caller asked to bypass actionability checks.

Source

pub fn is_trial(&self) -> bool

true when the caller asked to run checks only (no click).

Trait Implementations§

Source§

impl Clone for ClickOptions

Source§

fn clone(&self) -> ClickOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ClickOptions

Source§

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

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

impl Default for ClickOptions

Source§

fn default() -> ClickOptions

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> 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> 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
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,