Struct tor_rtmock::MockNetRuntime

pub struct MockNetRuntime<R: Runtime> { /* private fields */ }

A wrapper Runtime that overrides the SleepProvider trait for the underlying runtime.

Implementations

impl<R: Runtime> MockNetRuntime<R>

pub fn new(runtime: R, net: MockNetProvider) -> Self

Create a new runtime that wraps runtime, but overrides its view of the network with a MockNetProvider, net.

pub fn inner(&self) -> &R

Return a reference to the underlying runtime.

pub fn mock_net(&self) -> &MockNetProvider

Return a reference to the MockNetProvider

Trait Implementations

impl<R: Runtime> BlockOn for MockNetRuntime<R>

fn block_on<F: Future>(&self, future: F) -> F::Output

Run future until it is ready, and return its output.

impl<R: Clone + Runtime> Clone for MockNetRuntime<R>

fn clone(&self) -> MockNetRuntime<R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Runtime> CoarseTimeProvider for MockNetRuntime<R>

fn now_coarse(&self) -> CoarseInstant

Return the CoarseTimeProvider’s view of the current instant.

impl<R: Debug + Runtime> Debug for MockNetRuntime<R>

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

Formats the value using the given formatter.

impl<R: Runtime> SleepProvider for MockNetRuntime<R>

type SleepFuture = <R as SleepProvider>::SleepFuture

A future returned by SleepProvider::sleep()

fn sleep(&self, dur: Duration) -> Self::SleepFuture

Return a future that will be ready after duration has elapsed.

fn now(&self) -> Instant

Return the SleepProvider’s view of the current instant.

fn wallclock(&self) -> SystemTime

Return the SleepProvider’s view of the current wall-clock time.

fn block_advance<T: Into<String>>(&self, reason: T)

Signify that a test running under mock time shouldn’t advance time yet, with a given unique reason string. This is useful for making sure (mock) time doesn’t advance while things that might require some (real-world) time to complete do so, such as spawning a task on another thread.

fn release_advance<T: Into<String>>(&self, reason: T)

Signify that the reason to withhold time advancing provided in a call to block_advance no longer exists, and it’s fine to move time forward if nothing else is blocking advances.

fn allow_one_advance(&self, dur: Duration)

Allow a test running under mock time to advance time by the provided duration, even if the above block_advance API has been used.

impl<R: Runtime> Spawn for MockNetRuntime<R>

fn spawn_obj(&self, future: FutureObj<'static, ()>) -> Result<(), SpawnError>

Spawns a future that will be run to completion.

fn status(&self) -> Result<(), SpawnError>

Determines whether the executor is able to spawn new tasks.

impl<R: Runtime> TcpProvider for MockNetRuntime<R>

type TcpStream = <MockNetProvider as TcpProvider>::TcpStream

The type for the TCP connections returned by Self::connect().

type TcpListener = <MockNetProvider as TcpProvider>::TcpListener

The type for the TCP listeners returned by Self::listen().

fn connect<'life0, 'life1, 'async_trait>( &'life0 self, addr: &'life1 SocketAddr ) -> Pin<Box<dyn Future<Output = IoResult<Self::TcpStream>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Launch a TCP connection to a given socket address.

fn listen<'life0, 'life1, 'async_trait>( &'life0 self, addr: &'life1 SocketAddr ) -> Pin<Box<dyn Future<Output = IoResult<Self::TcpListener>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Open a TCP listener on a given socket address.

impl<R: Runtime> TlsProvider<<MockNetProvider as TcpProvider>::TcpStream> for MockNetRuntime<R>

type Connector = <MockNetProvider as TlsProvider<<MockNetProvider as TcpProvider>::TcpStream>>::Connector

The Connector object that this provider can return.

type TlsStream = <MockNetProvider as TlsProvider<<MockNetProvider as TcpProvider>::TcpStream>>::TlsStream

The type of the stream returned by that connector.

fn tls_connector(&self) -> Self::Connector

Return a TLS connector for use with this runtime.

impl<R: Runtime> UdpProvider for MockNetRuntime<R>

type UdpSocket = <MockNetProvider as UdpProvider>::UdpSocket

The type of Udp Socket returned by Self::bind()

fn bind<'life0, 'life1, 'async_trait>( &'life0 self, addr: &'life1 SocketAddr ) -> Pin<Box<dyn Future<Output = IoResult<Self::UdpSocket>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Bind a local port to send and receive packets from