Skip to main content

TestRuntime

Struct TestRuntime 

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

A test runtime with virtual time for deterministic testing.

Unlike real runtimes, time only advances when you call advance_by() or advance_to(). This allows instant, reproducible tests for time-based operators.

§Example

use agent_rex::TestRuntime;
 
#[tokio::test]
async fn test_debounce() {
  let runtime = TestRuntime::new();
   
  // Create a debounced stream using this runtime
  let source = futures::stream::iter(vec![1, 2, 3]);
  let debounced = debounce_with::<TestRuntime>(Duration::from_millis(100), source);
   
  // Advance virtual time to trigger debounce
  runtime.advance_by(Duration::from_millis(150)).await;
   
  // Collect results - happens instantly!
}

Implementations§

Source§

impl TestRuntime

Source

pub fn new() -> Self

Create a new test runtime starting at time zero.

Source

pub fn now(&self) -> Duration

Get the current virtual time.

Source

pub async fn advance_by(&self, duration: Duration)

Advance virtual time by the given duration.

This will wake any timers whose target time has been reached.

Source

pub async fn advance_to(&self, target: Duration)

Advance virtual time to a specific point.

Fires all timers between the current time and target time.

Source§

impl TestRuntime

Source

pub fn test_sleep(&self, duration: Duration) -> TestSleep

Create a sleep future tied to this runtime instance.

Source

pub fn test_interval(&self, period: Duration) -> TestInterval

Create an interval stream tied to this runtime instance.

Source§

impl TestRuntime

Source

pub async fn run_timed_test<T, F, Fut>(&self, steps: Vec<Duration>, f: F) -> T
where F: FnMut() -> Fut, Fut: Future<Output = T>,

Run a test with controlled time, returning the result.

This is a convenience method that advances time in steps, useful for testing debounce/throttle behavior.

Source

pub async fn assert_completes_within<T, Fut>( &self, timeout: Duration, fut: Fut, ) -> T
where Fut: Future<Output = T>,

Assert that a future completes within a virtual time budget.

Trait Implementations§

Source§

impl Clone for TestRuntime

Source§

fn clone(&self) -> TestRuntime

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 Default for TestRuntime

Source§

fn default() -> Self

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

impl Runtime for TestRuntime

Source§

fn sleep(duration: Duration) -> Pin<Box<dyn Future<Output = ()> + Send>>

Sleep for the given duration
Source§

fn interval(period: Duration) -> Pin<Box<dyn Stream<Item = ()> + Send>>

Create an interval that yields at regular intervals
Source§

fn spawn<F>(_future: F)
where F: Future<Output = ()> + Send + 'static,

Spawn a future as a background task

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, 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> 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.