Skip to main content

Clock

Struct Clock 

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

Playwright Clock — provides fake timer control for deterministic tests.

All methods send RPC calls on the owning BrowserContext channel.

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

Implementations§

Source§

impl Clock

Source

pub fn new(channel: Channel) -> Self

Creates a new Clock backed by the given BrowserContext channel.

Source

pub async fn install(&self, options: Option<ClockInstallOptions>) -> Result<()>

Installs fake timers, replacing the browser’s built-in clock APIs (Date, setTimeout, setInterval, etc.) with controlled equivalents.

§Arguments
  • options - Optional configuration; set time to fix the starting epoch timestamp in milliseconds.
§Errors

Returns error if:

  • Context has been closed
  • Communication with browser process fails

See: https://playwright.dev/docs/api/class-clock#clock-install

Source

pub async fn fast_forward(&self, ticks: u64) -> Result<()>

Advances the fake clock by the given number of milliseconds, firing any timers that fall within that range.

§Arguments
  • ticks - Number of milliseconds to advance the clock.
§Errors

Returns error if:

  • Clock is not installed
  • Context has been closed
  • Communication with browser process fails

See: https://playwright.dev/docs/api/class-clock#clock-fast-forward

Source

pub async fn pause_at(&self, time: u64) -> Result<()>

Pauses the fake clock at the given epoch timestamp (milliseconds).

No timers fire and time does not advance until Clock::resume is called.

§Arguments
  • time - Epoch timestamp in milliseconds to pause at.
§Errors

Returns error if:

  • Clock is not installed
  • Context has been closed
  • Communication with browser process fails

See: https://playwright.dev/docs/api/class-clock#clock-pause-at

Source

pub async fn resume(&self) -> Result<()>

Resumes the fake clock after it was paused via Clock::pause_at.

§Errors

Returns error if:

  • Context has been closed
  • Communication with browser process fails

See: https://playwright.dev/docs/api/class-clock#clock-resume

Source

pub async fn set_fixed_time(&self, time: u64) -> Result<()>

Freezes Date.now() and related APIs at the given epoch timestamp (milliseconds), without affecting timer scheduling.

§Arguments
  • time - Epoch timestamp in milliseconds.
§Errors

Returns error if:

  • Context has been closed
  • Communication with browser process fails

See: https://playwright.dev/docs/api/class-clock#clock-set-fixed-time

Source

pub async fn set_system_time(&self, time: u64) -> Result<()>

Updates the system time reported by Date and related APIs without freezing the clock or affecting timer scheduling.

§Arguments
  • time - Epoch timestamp in milliseconds.
§Errors

Returns error if:

  • Context has been closed
  • Communication with browser process fails

See: https://playwright.dev/docs/api/class-clock#clock-set-system-time

Trait Implementations§

Source§

impl Clone for Clock

Source§

fn clone(&self) -> Clock

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 Clock

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Clock

§

impl !RefUnwindSafe for Clock

§

impl Send for Clock

§

impl Sync for Clock

§

impl Unpin for Clock

§

impl UnsafeUnpin for Clock

§

impl !UnwindSafe for Clock

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