Struct tor_rtcompat::CompoundRuntime
source · pub struct CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR> { /* private fields */ }
Expand description
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§
source§impl<SpawnR, SleepR, TcpR, TlsR, UdpR> CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>
impl<SpawnR, SleepR, TcpR, TlsR, UdpR> CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>
Trait Implementations§
source§impl<SpawnR, SleepR, TcpR, TlsR, UdpR> BlockOn for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>
impl<SpawnR, SleepR, TcpR, TlsR, UdpR> BlockOn for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>
source§impl<SpawnR, SleepR, TcpR, TlsR, UdpR> Clone for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>
impl<SpawnR, SleepR, TcpR, TlsR, UdpR> Clone for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>
source§impl<SpawnR, SleepR, TcpR, TlsR, UdpR> Debug for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>
impl<SpawnR, SleepR, TcpR, TlsR, UdpR> Debug for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>
source§impl<SpawnR, SleepR, TcpR, TlsR, UdpR> SleepProvider for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>
impl<SpawnR, SleepR, TcpR, TlsR, UdpR> SleepProvider for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>
§type SleepFuture = <SleepR as SleepProvider>::SleepFuture
type SleepFuture = <SleepR as SleepProvider>::SleepFuture
A future returned by
SleepProvider::sleep()
source§fn sleep(&self, duration: Duration) -> Self::SleepFuture
fn sleep(&self, duration: Duration) -> Self::SleepFuture
Return a future that will be ready after
duration
has
elapsed.source§fn wallclock(&self) -> SystemTime
fn wallclock(&self) -> SystemTime
Return the SleepProvider’s view of the current wall-clock time. Read more
source§fn block_advance<T: Into<String>>(&self, _reason: T)
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. Read more
source§fn release_advance<T: Into<String>>(&self, _reason: T)
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. Read moresource§fn allow_one_advance(&self, _dur: Duration)
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 moresource§impl<SpawnR, SleepR, TcpR, TlsR, UdpR> Spawn for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>where
SpawnR: Spawn,
impl<SpawnR, SleepR, TcpR, TlsR, UdpR> Spawn for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>where
SpawnR: Spawn,
source§impl<SpawnR, SleepR, TcpR, TlsR, UdpR> TcpProvider for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>
impl<SpawnR, SleepR, TcpR, TlsR, UdpR> TcpProvider for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>
§type TcpStream = <TcpR as TcpProvider>::TcpStream
type TcpStream = <TcpR as TcpProvider>::TcpStream
The type for the TCP connections returned by
Self::connect()
.§type TcpListener = <TcpR as TcpProvider>::TcpListener
type TcpListener = <TcpR as TcpProvider>::TcpListener
The type for the TCP listeners returned by
Self::listen()
.source§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,
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. Read more
source§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,
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.
source§impl<SpawnR, SleepR, TcpR, TlsR, UdpR, S> TlsProvider<S> for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>
impl<SpawnR, SleepR, TcpR, TlsR, UdpR, S> TlsProvider<S> for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>
§type Connector = <TlsR as TlsProvider<S>>::Connector
type Connector = <TlsR as TlsProvider<S>>::Connector
The Connector object that this provider can return.
§type TlsStream = <TlsR as TlsProvider<S>>::TlsStream
type TlsStream = <TlsR as TlsProvider<S>>::TlsStream
The type of the stream returned by that connector.
source§fn tls_connector(&self) -> Self::Connector
fn tls_connector(&self) -> Self::Connector
Return a TLS connector for use with this runtime.
source§impl<SpawnR, SleepR, TcpR, TlsR, UdpR> UdpProvider for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>
impl<SpawnR, SleepR, TcpR, TlsR, UdpR> UdpProvider for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>
§type UdpSocket = <UdpR as UdpProvider>::UdpSocket
type UdpSocket = <UdpR as UdpProvider>::UdpSocket
The type of Udp Socket returned by
Self::bind()
Auto Trait Implementations§
impl<SpawnR, SleepR, TcpR, TlsR, UdpR> RefUnwindSafe for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>where
SleepR: RefUnwindSafe,
SpawnR: RefUnwindSafe,
TcpR: RefUnwindSafe,
TlsR: RefUnwindSafe,
UdpR: RefUnwindSafe,
impl<SpawnR, SleepR, TcpR, TlsR, UdpR> Send for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>
impl<SpawnR, SleepR, TcpR, TlsR, UdpR> Sync for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>
impl<SpawnR, SleepR, TcpR, TlsR, UdpR> Unpin for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>
impl<SpawnR, SleepR, TcpR, TlsR, UdpR> UnwindSafe for CompoundRuntime<SpawnR, SleepR, TcpR, TlsR, UdpR>where
SleepR: RefUnwindSafe,
SpawnR: RefUnwindSafe,
TcpR: RefUnwindSafe,
TlsR: RefUnwindSafe,
UdpR: RefUnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> SleepProviderExt for Twhere
T: SleepProvider,
impl<T> SleepProviderExt for Twhere
T: SleepProvider,
source§fn timeout<F: Future>(
&self,
duration: Duration,
future: F
) -> Timeout<F, Self::SleepFuture> ⓘ
fn timeout<F: Future>( &self, duration: Duration, future: F ) -> Timeout<F, Self::SleepFuture> ⓘ
source§fn sleep_until_wallclock(
&self,
when: SystemTime
) -> SleepUntilWallclock<'_, Self>
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 Spwhere
Sp: Spawn + ?Sized,
impl<Sp> SpawnExt for Spwhere
Sp: Spawn + ?Sized,
§fn spawn<Fut>(&self, future: Fut) -> Result<(), SpawnError>
fn spawn<Fut>(&self, future: Fut) -> Result<(), SpawnError>
Available on crate feature
alloc
only.Spawns a task that polls the given future with output
()
to
completion. Read more