Struct overclock::core::Abortable

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

A future/stream which can be remotely short-circuited using an AbortHandle.

Implementations

impl<T> Abortable<T>

NOTE: forked from rust futures

pub fn new(task: T, reg: AbortRegistration) -> Self

Create new abortable future/stream

pub fn is_aborted(&self) -> bool

Check if the abortable got aborted

Trait Implementations

impl<T> AsMut<T> for Abortable<T>

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl<R> AsyncRead for Abortable<R>where R: AsyncRead,

Implementation to make Abortable AsyncRead

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_> ) -> Poll<Result<()>>

Attempts to read from the AsyncRead into buf.

impl<R> AsyncWrite for Abortable<R>where R: AsyncWrite,

Implementation to make Abortable AsyncWrite

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8] ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>] ) -> Poll<Result<usize>>

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

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

Attempts to flush the object, ensuring that any buffered data reach their destination.

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

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

impl<T: Clone> Clone for Abortable<T>

fn clone(&self) -> Abortable<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Abortable<T>

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

Formats the value using the given formatter.

impl<T> Deref for Abortable<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for Abortable<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<Fut> Future for Abortable<Fut>where Fut: Future,

Implementation to make Abortable future

type Output = Result<<Fut as Future>::Output, Aborted>

The type of value produced on completion.

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

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

impl<St> Stream for Abortable<St>where St: Stream,

Implementation to make Abortable Stream

type Item = <St as Stream>::Item

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'__pin, T> Unpin for Abortable<T>where __Origin<'__pin, T>: Unpin,