Struct TokioStreamHandle 

pub struct TokioStreamHandle<T> { /* private fields */ }

Trait Implementations

impl<T> Future for TokioStreamHandle<T>

type Output = Result<T, StreamHandleError>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<T: Send> StreamHandle for TokioStreamHandle<T>

type StreamOutput = T

The Output type for the stream

fn wait_for_ready<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

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

Asynchronously waits for the stream to be fully spawned

fn end(&self)

Signal the stream to end Does not wait for the stream to end, so will not receive the result of stream.

fn end_and_wait<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<Self::StreamOutput, StreamHandleError>> + Send + 'async_trait>>

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

End the stream and asynchronously wait for it to shutdown, getting the result of its execution.

fn abort_handle(&self) -> Box<dyn AbortHandle>

Get an Abort Handle to the stream. This handle may be cloned/sent/etc easily and many handles may exist at once.

fn join<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = Result<Self::StreamOutput, StreamHandleError>> + Send + 'async_trait>>

where Self: 'async_trait,

Join the task back to the current thread, waiting until it ends.