Type Alias DynStream 

pub type DynStream = Pin<Box<dyn Stream<Item = Result<BytesMut, Error>> + Sync + Send>>;

Available on crate feature deploy_integration only.

Aliased Type

pub struct DynStream { /* private fields */ }

Implementations

impl<Ptr> Pin<Ptr>

where Ptr: Deref, <Ptr as Deref>::Target: Unpin,

pub const fn new(pointer: Ptr) -> Pin<Ptr>

Constructs a new Pin<Ptr> around a pointer to some data of a type that implements Unpin.

Unlike Pin::new_unchecked, this method is safe because the pointer Ptr dereferences to an Unpin type, which cancels the pinning guarantees.

Examples

use std::pin::Pin;

let mut val: u8 = 5;

// Since `val` doesn't care about being moved, we can safely create a "facade" `Pin`
// which will allow `val` to participate in `Pin`-bound apis  without checking that
// pinning guarantees are actually upheld.
let mut pinned: Pin<&mut u8> = Pin::new(&mut val);

pub const fn into_inner(pin: Pin<Ptr>) -> Ptr

Unwraps this Pin<Ptr>, returning the underlying pointer.

Doing this operation safely requires that the data pointed at by this pinning pointer implements Unpin so that we can ignore the pinning invariants when unwrapping it.

Examples

use std::pin::Pin;

let mut val: u8 = 5;
let pinned: Pin<&mut u8> = Pin::new(&mut val);

// Unwrap the pin to get the underlying mutable reference to the value. We can do
// this because `val` doesn't care about being moved, so the `Pin` was just
// a "facade" anyway.
let r = Pin::into_inner(pinned);
assert_eq!(*r, 5);

impl<Ptr> Pin<Ptr>

where Ptr: Deref,

pub const unsafe fn new_unchecked(pointer: Ptr) -> Pin<Ptr>

Constructs a new Pin<Ptr> around a reference to some data of a type that may or may not implement Unpin.

If pointer dereferences to an Unpin type, Pin::new should be used instead.

Safety

This constructor is unsafe because we cannot guarantee that the data pointed to by pointer is pinned. At its core, pinning a value means making the guarantee that the value’s data will not be moved nor have its storage invalidated until it gets dropped. For a more thorough explanation of pinning, see the pin module docs.

If the caller that is constructing this Pin<Ptr> does not ensure that the data Ptr points to is pinned, that is a violation of the API contract and may lead to undefined behavior in later (even safe) operations.

By using this method, you are also making a promise about the Deref, DerefMut, and Drop implementations of Ptr, if they exist. Most importantly, they must not move out of their self arguments: Pin::as_mut and Pin::as_ref will call DerefMut::deref_mut and Deref::deref on the pointer type Ptr and expect these methods to uphold the pinning invariants. Moreover, by calling this method you promise that the reference Ptr dereferences to will not be moved out of again; in particular, it must not be possible to obtain a &mut Ptr::Target and then move out of that reference (using, for example mem::swap).

For example, calling Pin::new_unchecked on an &'a mut T is unsafe because while you are able to pin it for the given lifetime 'a, you have no control over whether it is kept pinned once 'a ends, and therefore cannot uphold the guarantee that a value, once pinned, remains pinned until it is dropped:

use std::mem;
use std::pin::Pin;

fn move_pinned_ref<T>(mut a: T, mut b: T) {
    unsafe {
        let p: Pin<&mut T> = Pin::new_unchecked(&mut a);
        // This should mean the pointee `a` can never move again.
    }
    mem::swap(&mut a, &mut b); // Potential UB down the road ⚠️
    // The address of `a` changed to `b`'s stack slot, so `a` got moved even
    // though we have previously pinned it! We have violated the pinning API contract.
}

A value, once pinned, must remain pinned until it is dropped (unless its type implements Unpin). Because Pin<&mut T> does not own the value, dropping the Pin will not drop the value and will not end the pinning contract. So moving the value after dropping the Pin<&mut T> is still a violation of the API contract.

Similarly, calling Pin::new_unchecked on an Rc<T> is unsafe because there could be aliases to the same data that are not subject to the pinning restrictions:

use std::rc::Rc;
use std::pin::Pin;

fn move_pinned_rc<T>(mut x: Rc<T>) {
    // This should mean the pointee can never move again.
    let pin = unsafe { Pin::new_unchecked(Rc::clone(&x)) };
    {
        let p: Pin<&T> = pin.as_ref();
        // ...
    }
    drop(pin);

    let content = Rc::get_mut(&mut x).unwrap(); // Potential UB down the road ⚠️
    // Now, if `x` was the only reference, we have a mutable reference to
    // data that we pinned above, which we could use to move it as we have
    // seen in the previous example. We have violated the pinning API contract.
}

Pinning of closure captures

Particular care is required when using Pin::new_unchecked in a closure: Pin::new_unchecked(&mut var) where var is a by-value (moved) closure capture implicitly makes the promise that the closure itself is pinned, and that all uses of this closure capture respect that pinning.

use std::pin::Pin;
use std::task::Context;
use std::future::Future;

fn move_pinned_closure(mut x: impl Future, cx: &mut Context<'_>) {
    // Create a closure that moves `x`, and then internally uses it in a pinned way.
    let mut closure = move || unsafe {
        let _ignore = Pin::new_unchecked(&mut x).poll(cx);
    };
    // Call the closure, so the future can assume it has been pinned.
    closure();
    // Move the closure somewhere else. This also moves `x`!
    let mut moved = closure;
    // Calling it again means we polled the future from two different locations,
    // violating the pinning API contract.
    moved(); // Potential UB ⚠️
}

When passing a closure to another API, it might be moving the closure any time, so Pin::new_unchecked on closure captures may only be used if the API explicitly documents that the closure is pinned.

The better alternative is to avoid all that trouble and do the pinning in the outer function instead (here using the pin! macro):

use std::pin::pin;
use std::task::Context;
use std::future::Future;

fn move_pinned_closure(mut x: impl Future, cx: &mut Context<'_>) {
    let mut x = pin!(x);
    // Create a closure that captures `x: Pin<&mut _>`, which is safe to move.
    let mut closure = move || {
        let _ignore = x.as_mut().poll(cx);
    };
    // Call the closure, so the future can assume it has been pinned.
    closure();
    // Move the closure somewhere else.
    let mut moved = closure;
    // Calling it again here is fine (except that we might be polling a future that already
    // returned `Poll::Ready`, but that is a separate problem).
    moved();
}

pub fn as_ref(&self) -> Pin<&<Ptr as Deref>::Target>

where Ptr: Deref,

Gets a shared reference to the pinned value this Pin points to.

This is a generic method to go from &Pin<Pointer<T>> to Pin<&T>. It is safe because, as part of the contract of Pin::new_unchecked, the pointee cannot move after Pin<Pointer<T>> got created. “Malicious” implementations of Pointer::Deref are likewise ruled out by the contract of Pin::new_unchecked.

impl<Ptr> Pin<Ptr>

where Ptr: DerefMut,

pub fn as_mut(&mut self) -> Pin<&mut <Ptr as Deref>::Target>

where Ptr: DerefMut,

Gets a mutable reference to the pinned value this Pin<Ptr> points to.

This is a generic method to go from &mut Pin<Pointer<T>> to Pin<&mut T>. It is safe because, as part of the contract of Pin::new_unchecked, the pointee cannot move after Pin<Pointer<T>> got created. “Malicious” implementations of Pointer::DerefMut are likewise ruled out by the contract of Pin::new_unchecked.

This method is useful when doing multiple calls to functions that consume the pinning pointer.

Example

use std::pin::Pin;

impl Type {
    fn method(self: Pin<&mut Self>) {
        // do something
    }

    fn call_method_twice(mut self: Pin<&mut Self>) {
        // `method` consumes `self`, so reborrow the `Pin<&mut Self>` via `as_mut`.
        self.as_mut().method();
        self.as_mut().method();
    }
}

pub fn as_deref_mut( self: Pin<&mut Pin<Ptr>>, ) -> Pin<&mut <Ptr as Deref>::Target>

where Ptr: DerefMut,

Gets Pin<&mut T> to the underlying pinned value from this nested Pin-pointer.

This is a generic method to go from Pin<&mut Pin<Pointer<T>>> to Pin<&mut T>. It is safe because the existence of a Pin<Pointer<T>> ensures that the pointee, T, cannot move in the future, and this method does not enable the pointee to move. “Malicious” implementations of Ptr::DerefMut are likewise ruled out by the contract of Pin::new_unchecked.

pub fn set(&mut self, value: <Ptr as Deref>::Target)

where <Ptr as Deref>::Target: Sized,

Assigns a new value to the memory location pointed to by the Pin<Ptr>.

This overwrites pinned data, but that is okay: the original pinned value’s destructor gets run before being overwritten and the new value is also a valid value of the same type, so no pinning invariant is violated. See the pin module documentation for more information on how this upholds the pinning invariants.

Example

use std::pin::Pin;

let mut val: u8 = 5;
let mut pinned: Pin<&mut u8> = Pin::new(&mut val);
println!("{}", pinned); // 5
pinned.set(10);
println!("{}", pinned); // 10

impl<Ptr> Pin<Ptr>

where Ptr: Deref,

pub const unsafe fn into_inner_unchecked(pin: Pin<Ptr>) -> Ptr

Unwraps this Pin<Ptr>, returning the underlying Ptr.

Safety

This function is unsafe. You must guarantee that you will continue to treat the pointer Ptr as pinned after you call this function, so that the invariants on the Pin type can be upheld. If the code using the resulting Ptr does not continue to maintain the pinning invariants that is a violation of the API contract and may lead to undefined behavior in later (safe) operations.

Note that you must be able to guarantee that the data pointed to by Ptr will be treated as pinned all the way until its drop handler is complete!

For more information, see the pin module docs

If the underlying data is Unpin, Pin::into_inner should be used instead.

Trait Implementations

impl<P> AsyncBufRead for Pin<P>

where P: DerefMut + Unpin, <P as Deref>::Target: AsyncBufRead,

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

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 Pin<P>>, 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<P> AsyncBufRead for Pin<P>

where P: DerefMut, <P as Deref>::Target: AsyncBufRead,

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

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 Pin<P>>, 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<P> AsyncIterator for Pin<P>

where P: DerefMut, <P as Deref>::Target: AsyncIterator,

type Item = <<P as Deref>::Target as AsyncIterator>::Item

🔬This is a nightly-only experimental API. (async_iterator)

The type of items yielded by the async iterator.

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

🔬This is a nightly-only experimental API. (async_iterator)

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

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

🔬This is a nightly-only experimental API. (async_iterator)

Returns the bounds on the remaining length of the async iterator.

impl<P> AsyncRead for Pin<P>

where P: DerefMut + Unpin, <P as Deref>::Target: AsyncRead,

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

Attempt to read from the AsyncRead into buf.

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

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

impl<P> AsyncRead for Pin<P>

where P: DerefMut, <P as Deref>::Target: AsyncRead,

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

Attempts to read from the AsyncRead into buf.

impl<P> AsyncSeek for Pin<P>

where P: DerefMut + Unpin, <P as Deref>::Target: AsyncSeek,

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

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

impl<P> AsyncSeek for Pin<P>

where P: DerefMut, <P as Deref>::Target: AsyncSeek,

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

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

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

Waits for a seek operation to complete.

impl<P> AsyncWrite for Pin<P>

where P: DerefMut + Unpin, <P as Deref>::Target: AsyncWrite,

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

Attempt to write bytes from buf into the object.

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

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

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

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

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

Attempt to close the object.

impl<P> AsyncWrite for Pin<P>

where P: DerefMut, <P as Deref>::Target: AsyncWrite,

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

Attempt to write bytes from buf into the object.

fn poll_write_vectored( self: Pin<&mut Pin<P>>, 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.

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

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

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

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

impl<Ptr> Clone for Pin<Ptr>

where Ptr: Clone,

fn clone(&self) -> Pin<Ptr>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<G, R, A> Coroutine<R> for Pin<Box<G, A>>

where G: Coroutine<R> + ?Sized, A: Allocator + 'static,

type Yield = <G as Coroutine<R>>::Yield

🔬This is a nightly-only experimental API. (coroutine_trait)

The type of value this coroutine yields.

type Return = <G as Coroutine<R>>::Return

🔬This is a nightly-only experimental API. (coroutine_trait)

The type of value this coroutine returns.

fn resume( self: Pin<&mut Pin<Box<G, A>>>, arg: R, ) -> CoroutineState<<Pin<Box<G, A>> as Coroutine<R>>::Yield, <Pin<Box<G, A>> as Coroutine<R>>::Return>

🔬This is a nightly-only experimental API. (coroutine_trait)

Resumes the execution of this coroutine.

impl<Ptr> Debug for Pin<Ptr>

where Ptr: Debug,

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

Formats the value using the given formatter.

impl<T> Default for Pin<Box<T>>

where Box<T>: Default, T: ?Sized,

fn default() -> Pin<Box<T>>

Returns the “default value” for a type.

impl<Ptr> Deref for Pin<Ptr>

where Ptr: Deref,

type Target = <Ptr as Deref>::Target

The resulting type after dereferencing.

fn deref(&self) -> &<Ptr as Deref>::Target

Dereferences the value.

impl<Ptr> DerefMut for Pin<Ptr>

where Ptr: DerefMut, <Ptr as Deref>::Target: Unpin,

fn deref_mut(&mut self) -> &mut <Ptr as Deref>::Target

Mutably dereferences the value.

impl<Ptr> Display for Pin<Ptr>

where Ptr: Display,

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

Formats the value using the given formatter.

impl<T, A> From<Box<T, A>> for Pin<Box<T, A>>

where A: Allocator + 'static, T: ?Sized,

fn from(boxed: Box<T, A>) -> Pin<Box<T, A>>

Converts a Box<T> into a Pin<Box<T>>. If T does not implement Unpin, then *boxed will be pinned in memory and unable to be moved.

This conversion does not allocate on the heap and happens in place.

This is also available via Box::into_pin.

Constructing and pinning a Box with <Pin<Box<T>>>::from(Box::new(x)) can also be written more concisely using Box::pin(x). This From implementation is useful if you already have a Box<T>, or you are constructing a (pinned) Box in a different way than with Box::new.

impl<P> FusedFuture for Pin<P>

where P: DerefMut + Unpin, <P as Deref>::Target: FusedFuture,

fn is_terminated(&self) -> bool

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

impl<P> FusedStream for Pin<P>

where P: DerefMut + Unpin, <P as Deref>::Target: FusedStream,

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<P> Future for Pin<P>

where P: DerefMut, <P as Deref>::Target: Future,

type Output = <<P as Deref>::Target as Future>::Output

The type of value produced on completion.

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

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

impl<Ptr> Hash for Pin<Ptr>

where Ptr: Deref, <Ptr as Deref>::Target: Hash,

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Ptr> Ord for Pin<Ptr>

where Ptr: Deref, <Ptr as Deref>::Target: Ord,

fn cmp(&self, other: &Pin<Ptr>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<Ptr, Q> PartialEq<Pin<Q>> for Pin<Ptr>

where Ptr: Deref, Q: Deref, <Ptr as Deref>::Target: PartialEq<<Q as Deref>::Target>,

fn eq(&self, other: &Pin<Q>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Pin<Q>) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Ptr, Q> PartialOrd<Pin<Q>> for Pin<Ptr>

where Ptr: Deref, Q: Deref, <Ptr as Deref>::Target: PartialOrd<<Q as Deref>::Target>,

fn partial_cmp(&self, other: &Pin<Q>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Pin<Q>) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Pin<Q>) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Pin<Q>) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Pin<Q>) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Ptr> Pointer for Pin<Ptr>

where Ptr: Pointer,

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

Formats the value using the given formatter.

impl<P, Item> Sink<Item> for Pin<P>

where P: DerefMut + Unpin, <P as Deref>::Target: Sink<Item>,

type Error = <<P as Deref>::Target as Sink<Item>>::Error

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

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

Attempts to prepare the Sink to receive a value.

fn start_send( self: Pin<&mut Pin<P>>, item: Item, ) -> Result<(), <Pin<P> as Sink<Item>>::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 Pin<P>>, cx: &mut Context<'_>, ) -> Poll<Result<(), <Pin<P> as Sink<Item>>::Error>>

Flush any remaining output from this sink.

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

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

impl<P> Stream for Pin<P>

where P: DerefMut + Unpin, <P as Deref>::Target: Stream,

type Item = <<P as Deref>::Target as Stream>::Item

Values yielded by the stream.

fn poll_next( self: Pin<&mut Pin<P>>, cx: &mut Context<'_>, ) -> Poll<Option<<Pin<P> as Stream>::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<'a, T, F> UnsafeFutureObj<'a, T> for Pin<Box<F>>

where F: Future<Output = T> + 'a,

fn into_raw(self) -> *mut dyn Future<Output = T> + 'a

Convert an owned instance into a (conceptually owned) fat pointer.

unsafe fn drop(ptr: *mut dyn Future<Output = T> + 'a)

Drops the future represented by the given fat pointer.

impl<Ptr, U> CoerceUnsized<Pin<U>> for Pin<Ptr>

where Ptr: CoerceUnsized<U> + PinCoerceUnsized, U: PinCoerceUnsized,

impl<Ptr> Copy for Pin<Ptr>

where Ptr: Copy,

impl<Ptr> DerefPure for Pin<Ptr>

where Ptr: DerefPure,

impl<Ptr, U> DispatchFromDyn<Pin<U>> for Pin<Ptr>

where Ptr: DispatchFromDyn<U> + PinCoerceUnsized, U: PinCoerceUnsized,

impl<Ptr> Eq for Pin<Ptr>

where Ptr: Deref, <Ptr as Deref>::Target: Eq,

impl<T> PinCoerceUnsized for Pin<T>

where T: PinCoerceUnsized,