Clock

Struct Clock 

Source
pub struct Clock;
Expand description

Global clock access - like Utc::now() but testable.

Implementations§

Source§

impl Clock

Source

pub fn now() -> DateTime<Utc>

Get current time from the global clock.

Lazily initializes to realtime if not already set.

Source

pub fn today() -> NaiveDate

Get the current date (without time component).

Lazily initializes to realtime if not already set.

Source

pub fn sleep(duration: Duration) -> ClockSleep

Sleep using the global clock.

Source

pub fn timeout<F: Future>(duration: Duration, future: F) -> ClockTimeout<F>

Timeout using the global clock.

Source

pub fn handle() -> &'static ClockHandle

Get a reference to the global clock handle.

Source

pub fn install_artificial(config: ArtificialClockConfig) -> ClockController

Install an artificial clock globally.

  • If not initialized: installs artificial clock, returns controller
  • If already artificial: returns existing controller (idempotent)
  • If already realtime: panics

Must be called before any Clock::now() calls if you want artificial time.

Source

pub fn is_artificial() -> bool

Check if an artificial clock is installed.

Source

pub fn artificial_now() -> Option<DateTime<Utc>>

Get the current artificial time, if an artificial clock is installed and hasn’t transitioned to realtime.

Returns:

  • None if no clock is initialized (doesn’t initialize one)
  • None for realtime clocks
  • None for artificial clocks that have transitioned to realtime
  • Some(time) for artificial clocks that are still artificial

Auto Trait Implementations§

§

impl Freeze for Clock

§

impl RefUnwindSafe for Clock

§

impl Send for Clock

§

impl Sync for Clock

§

impl Unpin 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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. 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