Struct tor_rtmock::MockNetRuntime

source · [−]

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

Expand description

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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

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. Read more

fn now(&self) -> Instant

Return the SleepProvider’s view of the current instant. Read more

fn wallclock(&self) -> SystemTime

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

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

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. Read more

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

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. Read more

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. Read more

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. Read more

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

Determines whether the executor is able to spawn new tasks. Read more

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
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Launch a TCP connection to a given socket address. Read more

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

Open a TCP listener on a given socket address.

impl<R: Runtime> TlsProvider<LocalStream> for MockNetRuntime<R>

type Connector = <MockNetProvider as TlsProvider<LocalStream>>::Connector

The Connector object that this provider can return.

type TlsStream = <MockNetProvider as TlsProvider<LocalStream>>::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 = <R 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
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Bind a local port to send and receive packets from

Auto Trait Implementations

impl<R> RefUnwindSafe for MockNetRuntime<R> where
R: RefUnwindSafe,

impl<R> Send for MockNetRuntime<R>

impl<R> Sync for MockNetRuntime<R>

impl<R> Unpin for MockNetRuntime<R> where
R: Unpin,

impl<R> UnwindSafe for MockNetRuntime<R> where
R: UnwindSafe,

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · 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.

impl<T> SleepProviderExt for T where
T: SleepProvider,

fn timeout<F>(
    &self,
    duration: Duration,
    future: F
) -> Timeout<F, Self::SleepFuture> where
    F: Future,

Wrap a Future with a timeout. Read more

fn sleep_until_wallclock(
&self,
when: SystemTime
) -> SleepUntilWallclock<'_, Self>

Pause until the wall-clock is at when or later, trying to recover from clock jumps. Read more

impl<Sp> SpawnExt for Sp where
Sp: Spawn + ?Sized,

fn spawn<Fut>(&self, future: Fut) -> Result<(), SpawnError> where
Fut: 'static + Future<Output = ()> + Send,

Spawns a task that polls the given future with output () to completion. Read more

fn spawn_with_handle<Fut>(
    &self,
    future: Fut
) -> Result<RemoteHandle<<Fut as Future>::Output>, SpawnError> where
    Fut: 'static + Future + Send,
    <Fut as Future>::Output: Send,

Spawns a task that polls the given future to completion and returns a future that resolves to the spawned future’s output. Read more

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more