Struct tor_rtcompat::CompoundRuntime

pub struct CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR> { /* private fields */ }

A runtime made of several parts, each of which implements one trait-group.

The SpawnR component should implements [Spawn] and BlockOn; the SleepR component should implement SleepProvider; the TcpR component should implement TcpProvider; and the TlsR component should implement TlsProvider.

You can use this structure to create new runtimes in two ways: either by overriding a single part of an existing runtime, or by building an entirely new runtime from pieces.

Implementations

impl<SpawnR, SleepR, TcpR, TlsR, UdpR> CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>

pub fn new(
    spawn: SpawnR,
    sleep: SleepR,
    tcp: TcpR,
    tls: TlsR,
    udp: UdpR
) -> Self

Construct a new CompoundRuntime from its components.

Trait Implementations

impl<SpawnR, SleepR, TcpR, TlsR, UdpR> BlockOn for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR> where
    SpawnR: BlockOn, 

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

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

impl<SpawnR, SleepR, TcpR, TlsR, UdpR> Clone for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<SpawnR, SleepR, TcpR, TlsR, UdpR> Debug for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>

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

Formats the value using the given formatter.

impl<SpawnR, SleepR, TcpR, TlsR, UdpR> SleepProvider for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR> where
    SleepR: SleepProvider, 

type SleepFuture = <SleepR as SleepProvider>::SleepFuture

A future returned by SleepProvider::sleep()

fn sleep(&self, duration: 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<SpawnR, SleepR, TcpR, TlsR, UdpR> Spawn for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR> where
    SpawnR: Spawn, 

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<SpawnR, SleepR, TcpR, TlsR, UdpR> TcpProvider for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR> where
    TcpR: TcpProvider,
    SpawnR: Send + Sync + 'static,
    SleepR: Send + Sync + 'static,
    TcpR: Send + Sync + 'static,
    TlsR: Send + Sync + 'static,
    UdpR: Send + Sync + 'static, 

type TcpStream = <TcpR as TcpProvider>::TcpStream

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

type TcpListener = <TcpR 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.

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<SpawnR, SleepR, TcpR, TlsR, UdpR, S> TlsProvider<S> for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR> where
    TcpR: TcpProvider,
    TlsR: TlsProvider<S>, 

type Connector = <TlsR as TlsProvider<S>>::Connector

The Connector object that this provider can return.

type TlsStream = <TlsR as TlsProvider<S>>::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<SpawnR, SleepR, TcpR, TlsR, UdpR> UdpProvider for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR> where
    UdpR: UdpProvider,
    SpawnR: Send + Sync + 'static,
    SleepR: Send + Sync + 'static,
    TcpR: Send + Sync + 'static,
    TlsR: Send + Sync + 'static,
    UdpR: Send + Sync + 'static, 

type UdpSocket = <UdpR 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