      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302

    //! Types which pin data to its location in memory
    //!
    //! It is sometimes useful to have objects that are guaranteed to not move,
    //! in the sense that their placement in memory does not change, and can thus be relied upon.
    //!
    //! A prime example of such a scenario would be building self-referencial structs,
    //! since moving an object with pointers to itself will invalidate them,
    //! which could cause undefined behavior.
    //!
    //! In order to prevent objects from moving, they must be *pinned*,
    //! by wrapping the data in pinning pointer types, such as [`PinMut`] and [`PinBox`],
    //! which are otherwise equivalent to `& mut` and [`Box`], respectively.
    //!
    //! First of all, these are pointer types because pinned data mustn't be passed around by value
    //! (that would change its location in memory).
    //! Secondly, since data can be moved out of `&mut` and [`Box`] with functions such as [`swap`],
    //! which causes their contents to swap places in memory,
    //! we need dedicated types that prohibit such operations.
    //!
    //! However, these restrictions are usually not necessary,
    //! so most types implement the [`Unpin`] auto-trait,
    //! which indicates that the type can be moved out safely.
    //! Doing so removes the limitations of pinning types,
    //! making them the same as their non-pinning counterparts.
    //!
    //! [`PinMut`]: struct.PinMut.html
    //! [`PinBox`]: struct.PinBox.html
    //! [`Unpin`]: trait.Unpin.html
    //! [`swap`]: ../../std/mem/fn.swap.html
    //! [`Box`]: ../boxed/struct.Box.html
    //!
    //! # Examples
    //!
    //! ```rust
    //! #![feature(pin)]
    //!
    //! use std::pin::PinBox;
    //! use std::marker::Pinned;
    //! use std::ptr::NonNull;
    //!
    //! // This is a self referencial struct since the slice field points to the data field.
    //! // We cannot inform the compiler about that with a normal reference,
    //! // since this pattern cannot be described with the usual borrowing rules.
    //! // Instead we use a raw pointer, though one which is known to not be null,
    //! // since we know it's pointing at the string.
    //! struct Unmovable {
    //!     data: String,
    //!     slice: NonNull<String>,
    //!     _pin: Pinned,
    //! }
    //!
    //! impl Unmovable {
    //!     // To ensure the data doesn't move when the function returns,
    //!     // we place it in the heap where it will stay for the lifetime of the object,
    //!     // and the only way to access it would be through a pointer to it.
    //!     fn new(data: String) -> PinBox<Self> {
    //!         let res = Unmovable {
    //!             data,
    //!             // we only create the pointer once the data is in place
    //!             // otherwise it will have already moved before we even started
    //!             slice: NonNull::dangling(),
    //!             _pin: Pinned,
    //!         };
    //!         let mut boxed = PinBox::new(res);
    //!
    //!         let slice = NonNull::from(&boxed.data);
    //!         // we know this is safe because modifying a field doesn't move the whole struct
    //!         unsafe { PinBox::get_mut(&mut boxed).slice = slice };
    //!         boxed
    //!     }
    //! }
    //!
    //! let unmoved = Unmovable::new("hello".to_string());
    //! // The pointer should point to the correct location,
    //! // so long as the struct hasn't moved.
    //! // Meanwhile, we are free to move the pointer around.
    //! # #[allow(unused_mut)]
    //! let mut still_unmoved = unmoved;
    //! assert_eq!(still_unmoved.slice, NonNull::from(&still_unmoved.data));
    //!
    //! // Since our type doesn't implement Unpin, this will fail to compile:
    //! // let new_unmoved = Unmovable::new("world".to_string());
    //! // std::mem::swap(&mut *still_unmoved, &mut *new_unmoved);
    //! ```

    #![unstable(feature = "pin", issue = "49150")]

    pub use core::pin::*;
    pub use core::marker::Unpin;

    use core::convert::From;
    use core::fmt;
    use core::future::{Future, FutureObj, LocalFutureObj, UnsafeFutureObj};
    use core::marker::Unsize;
    use core::ops::{CoerceUnsized, Deref, DerefMut};
    use core::task::{Context, Poll};

    use boxed::Box;

    /// A pinned, heap allocated reference.
    ///
    /// This type is similar to [`Box`], except that it pins its value,
    /// which prevents it from moving out of the reference, unless it implements [`Unpin`].
    ///
    /// See the [module documentation] for furthur explaination on pinning.
    ///
    /// [`Box`]: ../boxed/struct.Box.html
    /// [`Unpin`]: ../../std/marker/trait.Unpin.html
    /// [module documentation]: index.html
    #[unstable(feature = "pin", issue = "49150")]
    #[fundamental]
    #[repr(transparent)]
    pub struct PinBox<T: ?Sized> {
        inner: Box<T>,
    }

    #[unstable(feature = "pin", issue = "49150")]
    impl<T> PinBox<T> {
        /// Allocate memory on the heap, move the data into it and pin it.
        #[unstable(feature = "pin", issue = "49150")]
        pub fn new(data: T) -> PinBox<T> {
            PinBox { inner: Box::new(data) }
        }
    }

    #[unstable(feature = "pin", issue = "49150")]
    impl<T: ?Sized> PinBox<T> {
        /// Get a pinned reference to the data in this PinBox.
        #[inline]
        pub fn as_pin_mut<'a>(&'a mut self) -> PinMut<'a, T> {
            unsafe { PinMut::new_unchecked(&mut *self.inner) }
        }

        /// Constructs a `PinBox` from a raw pointer.
        ///
        /// After calling this function, the raw pointer is owned by the
        /// resulting `PinBox`. Specifically, the `PinBox` destructor will call
        /// the destructor of `T` and free the allocated memory. Since the
        /// way `PinBox` allocates and releases memory is unspecified, the
        /// only valid pointer to pass to this function is the one taken
        /// from another `PinBox` via the [`PinBox::into_raw`] function.
        ///
        /// This function is unsafe because improper use may lead to
        /// memory problems. For example, a double-free may occur if the
        /// function is called twice on the same raw pointer.
        ///
        /// [`PinBox::into_raw`]: struct.PinBox.html#method.into_raw
        ///
        /// # Examples
        ///
        /// ```
        /// #![feature(pin)]
        /// use std::pin::PinBox;
        /// let x = PinBox::new(5);
        /// let ptr = PinBox::into_raw(x);
        /// let x = unsafe { PinBox::from_raw(ptr) };
        /// ```
        #[inline]
        pub unsafe fn from_raw(raw: *mut T) -> Self {
            PinBox { inner: Box::from_raw(raw) }
        }

        /// Consumes the `PinBox`, returning the wrapped raw pointer.
        ///
        /// After calling this function, the caller is responsible for the
        /// memory previously managed by the `PinBox`. In particular, the
        /// caller should properly destroy `T` and release the memory. The
        /// proper way to do so is to convert the raw pointer back into a
        /// `PinBox` with the [`PinBox::from_raw`] function.
        ///
        /// Note: this is an associated function, which means that you have
        /// to call it as `PinBox::into_raw(b)` instead of `b.into_raw()`. This
        /// is so that there is no conflict with a method on the inner type.
        ///
        /// [`PinBox::from_raw`]: struct.PinBox.html#method.from_raw
        ///
        /// # Examples
        ///
        /// ```
        /// #![feature(pin)]
        /// use std::pin::PinBox;
        /// let x = PinBox::new(5);
        /// let ptr = PinBox::into_raw(x);
        /// ```
        #[inline]
        pub fn into_raw(b: PinBox<T>) -> *mut T {
            Box::into_raw(b.inner)
        }

        /// Get a mutable reference to the data inside this PinBox.
        ///
        /// This function is unsafe. Users must guarantee that the data is never
        /// moved out of this reference.
        #[inline]
        pub unsafe fn get_mut<'a>(this: &'a mut PinBox<T>) -> &'a mut T {
            &mut *this.inner
        }

        /// Convert this PinBox into an unpinned Box.
        ///
        /// This function is unsafe. Users must guarantee that the data is never
        /// moved out of the box.
        #[inline]
        pub unsafe fn unpin(this: PinBox<T>) -> Box<T> {
            this.inner
        }
    }

    #[unstable(feature = "pin", issue = "49150")]
    impl<T: ?Sized> From<Box<T>> for PinBox<T> {
        fn from(boxed: Box<T>) -> PinBox<T> {
            PinBox { inner: boxed }
        }
    }

    #[unstable(feature = "pin", issue = "49150")]
    impl<T: ?Sized> Deref for PinBox<T> {
        type Target = T;

        fn deref(&self) -> &T {
            &*self.inner
        }
    }

    #[unstable(feature = "pin", issue = "49150")]
    impl<T: Unpin + ?Sized> DerefMut for PinBox<T> {
        fn deref_mut(&mut self) -> &mut T {
            &mut *self.inner
        }
    }

    #[unstable(feature = "pin", issue = "49150")]
    impl<T: fmt::Display + ?Sized> fmt::Display for PinBox<T> {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            fmt::Display::fmt(&*self.inner, f)
        }
    }

    #[unstable(feature = "pin", issue = "49150")]
    impl<T: fmt::Debug + ?Sized> fmt::Debug for PinBox<T> {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            fmt::Debug::fmt(&*self.inner, f)
        }
    }

    #[unstable(feature = "pin", issue = "49150")]
    impl<T: ?Sized> fmt::Pointer for PinBox<T> {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            // It's not possible to extract the inner Uniq directly from the Box,
            // instead we cast it to a *const which aliases the Unique
            let ptr: *const T = &*self.inner;
            fmt::Pointer::fmt(&ptr, f)
        }
    }

    #[unstable(feature = "pin", issue = "49150")]
    impl<T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<PinBox<U>> for PinBox<T> {}

    #[unstable(feature = "pin", issue = "49150")]
    impl<T: ?Sized> Unpin for PinBox<T> {}

    #[unstable(feature = "futures_api", issue = "50547")]
    impl<F: ?Sized + Future> Future for PinBox<F> {
        type Output = F::Output;

        fn poll(mut self: PinMut<Self>, cx: &mut Context) -> Poll<Self::Output> {
            self.as_pin_mut().poll(cx)
        }
    }

    #[unstable(feature = "futures_api", issue = "50547")]
    unsafe impl<'a, T, F> UnsafeFutureObj<'a, T> for PinBox<F>
        where F: Future<Output = T> + 'a
    {
        fn into_raw(self) -> *mut () {
            PinBox::into_raw(self) as *mut ()
        }

        unsafe fn poll(ptr: *mut (), cx: &mut Context) -> Poll<T> {
            let ptr = ptr as *mut F;
            let pin: PinMut<F> = PinMut::new_unchecked(&mut *ptr);
            pin.poll(cx)
        }

        unsafe fn drop(ptr: *mut ()) {
            drop(PinBox::from_raw(ptr as *mut F))
        }
    }

    #[unstable(feature = "futures_api", issue = "50547")]
    impl<'a, F: Future<Output = ()> + Send + 'a> From<PinBox<F>> for FutureObj<'a, ()> {
        fn from(boxed: PinBox<F>) -> Self {
            FutureObj::new(boxed)
        }
    }

    #[unstable(feature = "futures_api", issue = "50547")]
    impl<'a, F: Future<Output = ()> + 'a> From<PinBox<F>> for LocalFutureObj<'a, ()> {
        fn from(boxed: PinBox<F>) -> Self {
            LocalFutureObj::new(boxed)
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)