Struct AssertUnmoved 

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

A type that asserts that the underlying type is not moved after being pinned and mutably accessed.

See crate level documentation for details.

Implementations

impl<T> AssertUnmoved<T>

pub const fn new(inner: T) -> Self

Creates a new AssertUnmoved.

pub const fn get_ref(&self) -> &T

Gets a reference to the underlying type.

Unlike get_mut method, this method can always called.

You can also access the underlying type via Deref impl.

pub fn get_mut(&mut self) -> &mut T

Gets a mutable reference to the underlying type.

Note that this method can only be called before pinned since AssertUnmoved is !Unpin (this is guaranteed by the type system!).

Panics

Panics if this AssertUnmoved moved after being pinned and mutably accessed.

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T>

Gets a pinned mutable reference to the underlying type.

Panics

Panics if this AssertUnmoved moved after being pinned and mutably accessed.

Examples

Implement own Stream trait for AssertUnmoved.

use std::{
    pin::Pin,
    task::{Context, Poll},
};

use assert_unmoved::AssertUnmoved;

pub trait MyStream {
    type Item;

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

impl<S: MyStream> MyStream for AssertUnmoved<S> {
    type Item = S::Item;

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

Trait Implementations

impl<R: AsyncBufRead> AsyncBufRead for AssertUnmoved<R>

Available on crate feature futures03 only.

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

Attempt to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut Self>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to poll_read.

impl<R: AsyncBufRead> AsyncBufRead for AssertUnmoved<R>

Available on crate feature tokio02 only.

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

Attempts to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut Self>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to poll_read.

impl<R: AsyncBufRead> AsyncBufRead for AssertUnmoved<R>

Available on crate feature tokio03 only.

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

Attempts to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut Self>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to poll_read.

impl<R: AsyncBufRead> AsyncBufRead for AssertUnmoved<R>

Available on crate feature tokio1 only.

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

Attempts to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut Self>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to poll_read.

impl<R: AsyncRead> AsyncRead for AssertUnmoved<R>

Available on crate feature futures03 only.

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

Attempt to read from the AsyncRead into buf.

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

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<R: AsyncRead> AsyncRead for AssertUnmoved<R>

Available on crate feature tokio02 only.

unsafe fn prepare_uninitialized_buffer( &self, buf: &mut [MaybeUninit<u8>], ) -> bool

Prepares an uninitialized buffer to be safe to pass to read. Returns true if the supplied buffer was zeroed out.

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

Attempts to read from the AsyncRead into buf.

fn poll_read_buf<B: BufMut>( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut B, ) -> Poll<Result<usize>>

where Self: Sized,

Pulls some bytes from this source into the specified BufMut, returning how many bytes were read.

impl<R: AsyncRead> AsyncRead for AssertUnmoved<R>

Available on crate feature tokio03 only.

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: AsyncRead> AsyncRead for AssertUnmoved<R>

Available on crate feature tokio1 only.

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

Attempts to read from the AsyncRead into buf.

impl<S: AsyncSeek> AsyncSeek for AssertUnmoved<S>

Available on crate feature futures03 only.

fn poll_seek( self: Pin<&mut Self>, cx: &mut Context<'_>, pos: SeekFrom, ) -> Poll<Result<u64>>

Attempt to seek to an offset, in bytes, in a stream.

impl<S: AsyncSeek> AsyncSeek for AssertUnmoved<S>

Available on crate feature tokio02 only.

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

Attempts to seek to an offset, in bytes, in a stream.

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

Waits for a seek operation to complete.

impl<S: AsyncSeek> AsyncSeek for AssertUnmoved<S>

Available on crate feature tokio03 only.

fn start_seek(self: Pin<&mut Self>, pos: SeekFrom) -> Result<()>

Attempts to seek to an offset, in bytes, in a stream.

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

Waits for a seek operation to complete.

impl<S: AsyncSeek> AsyncSeek for AssertUnmoved<S>

Available on crate feature tokio1 only.

fn start_seek(self: Pin<&mut Self>, pos: SeekFrom) -> Result<()>

Attempts to seek to an offset, in bytes, in a stream.

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

Waits for a seek operation to complete.

impl<W: AsyncWrite> AsyncWrite for AssertUnmoved<W>

Available on crate feature futures03 only.

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>>

Attempt to write bytes from bufs into the object using vectored IO operations.

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

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

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

Attempt to close the object.

impl<W: AsyncWrite> AsyncWrite for AssertUnmoved<W>

Available on crate feature tokio02 only.

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_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.

fn poll_write_buf<B: Buf>( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut B, ) -> Poll<Result<usize, Error>>

where Self: Sized,

Writes a Buf into this value, returning how many bytes were written.

impl<W: AsyncWrite> AsyncWrite for AssertUnmoved<W>

Available on crate feature tokio03 only.

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_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.

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

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.

impl<W: AsyncWrite> AsyncWrite for AssertUnmoved<W>

Available on crate feature tokio1 only.

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_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.

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

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.

impl<T: Debug> Debug for AssertUnmoved<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for AssertUnmoved<T>

fn default() -> Self

Creates a new AssertUnmoved, with the default value for T.

This is equivalent to AssertUnmoved::new(T::default()).

impl<T> Deref for AssertUnmoved<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> Drop for AssertUnmoved<T>

fn drop(&mut self)

Panics

Panics if this AssertUnmoved moved after being pinned and mutably accessed.

impl<T> From<T> for AssertUnmoved<T>

fn from(inner: T) -> Self

Converts a T into a AssertUnmoved<T>.

This is equivalent to AssertUnmoved::new.

impl<F: FusedFuture> FusedFuture for AssertUnmoved<F>

Available on crate feature futures03 only.

fn is_terminated(&self) -> bool

Returns true if the underlying future should no longer be polled.

impl<S: FusedStream> FusedStream for AssertUnmoved<S>

Available on crate feature futures03 only.

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<F: Future> Future for AssertUnmoved<F>

type Output = <F as Future>::Output

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<S: Sink<Item>, Item> Sink<Item> for AssertUnmoved<S>

Available on crate feature futures03 only.

type Error = <S as Sink<Item>>::Error

The type of value produced by the sink when an error occurs.

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

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: Item) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

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

Flush any remaining output from this sink.

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

Flush any remaining output and close this sink, if necessary.

impl<S: Stream> Stream for AssertUnmoved<S>

Available on crate feature futures03 only.

type Item = <S 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.