future_obj.rs.html -- source
Description: Source to the Rust file `libcore/future/future_obj.rs`.
Keywords: rust, rustlang, rust-lang

      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

    // Copyright 2018 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    #![unstable(feature = "futures_api",
                reason = "futures in libcore are unstable",
                issue = "50547")]

    use fmt;
    use future::Future;
    use marker::{PhantomData, Unpin};
    use pin::PinMut;
    use task::{Context, Poll};

    /// A custom trait object for polling futures, roughly akin to
    /// `Box<dyn Future<Output = T> + 'a>`.
    ///
    /// This custom trait object was introduced for two reasons:
    /// - Currently it is not possible to take `dyn Trait` by value and
    ///   `Box<dyn Trait>` is not available in no_std contexts.
    /// - The `Future` trait is currently not object safe: The `Future::poll`
    ///   method makes uses the arbitrary self types feature and traits in which
    ///   this feature is used are currently not object safe due to current compiler
    ///   limitations. (See tracking issue for arbitrary self types for more
    ///   information #44874)
    pub struct LocalFutureObj<'a, T> {
        ptr: *mut (),
        poll_fn: unsafe fn(*mut (), &mut Context) -> Poll<T>,
        drop_fn: unsafe fn(*mut ()),
        _marker: PhantomData<&'a ()>,
    }

    impl<'a, T> Unpin for LocalFutureObj<'a, T> {}

    impl<'a, T> LocalFutureObj<'a, T> {
        /// Create a `LocalFutureObj` from a custom trait object representation.
        #[inline]
        pub fn new<F: UnsafeFutureObj<'a, T> + 'a>(f: F) -> LocalFutureObj<'a, T> {
            LocalFutureObj {
                ptr: f.into_raw(),
                poll_fn: F::poll,
                drop_fn: F::drop,
                _marker: PhantomData,
            }
        }

        /// Converts the `LocalFutureObj` into a `FutureObj`
        /// To make this operation safe one has to ensure that the `UnsafeFutureObj`
        /// instance from which this `LocalFutureObj` was created actually
        /// implements `Send`.
        #[inline]
        pub unsafe fn into_future_obj(self) -> FutureObj<'a, T> {
            FutureObj(self)
        }
    }

    impl<'a, T> fmt::Debug for LocalFutureObj<'a, T> {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            f.debug_struct("LocalFutureObj")
                .finish()
        }
    }

    impl<'a, T> From<FutureObj<'a, T>> for LocalFutureObj<'a, T> {
        #[inline]
        fn from(f: FutureObj<'a, T>) -> LocalFutureObj<'a, T> {
            f.0
        }
    }

    impl<'a, T> Future for LocalFutureObj<'a, T> {
        type Output = T;

        #[inline]
        fn poll(self: PinMut<Self>, cx: &mut Context) -> Poll<T> {
            unsafe {
                (self.poll_fn)(self.ptr, cx)
            }
        }
    }

    impl<'a, T> Drop for LocalFutureObj<'a, T> {
        fn drop(&mut self) {
            unsafe {
                (self.drop_fn)(self.ptr)
            }
        }
    }

    /// A custom trait object for polling futures, roughly akin to
    /// `Box<dyn Future<Output = T> + Send + 'a>`.
    ///
    /// This custom trait object was introduced for two reasons:
    /// - Currently it is not possible to take `dyn Trait` by value and
    ///   `Box<dyn Trait>` is not available in no_std contexts.
    /// - The `Future` trait is currently not object safe: The `Future::poll`
    ///   method makes uses the arbitrary self types feature and traits in which
    ///   this feature is used are currently not object safe due to current compiler
    ///   limitations. (See tracking issue for arbitrary self types for more
    ///   information #44874)
    pub struct FutureObj<'a, T>(LocalFutureObj<'a, T>);

    impl<'a, T> Unpin for FutureObj<'a, T> {}
    unsafe impl<'a, T> Send for FutureObj<'a, T> {}

    impl<'a, T> FutureObj<'a, T> {
        /// Create a `FutureObj` from a custom trait object representation.
        #[inline]
        pub fn new<F: UnsafeFutureObj<'a, T> + Send>(f: F) -> FutureObj<'a, T> {
            FutureObj(LocalFutureObj::new(f))
        }
    }

    impl<'a, T> fmt::Debug for FutureObj<'a, T> {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            f.debug_struct("FutureObj")
                .finish()
        }
    }

    impl<'a, T> Future for FutureObj<'a, T> {
        type Output = T;

        #[inline]
        fn poll(self: PinMut<Self>, cx: &mut Context) -> Poll<T> {
            let pinned_field = unsafe { PinMut::map_unchecked(self, |x| &mut x.0) };
            pinned_field.poll(cx)
        }
    }

    /// A custom implementation of a future trait object for `FutureObj`, providing
    /// a hand-rolled vtable.
    ///
    /// This custom representation is typically used only in `no_std` contexts,
    /// where the default `Box`-based implementation is not available.
    ///
    /// The implementor must guarantee that it is safe to call `poll` repeatedly (in
    /// a non-concurrent fashion) with the result of `into_raw` until `drop` is
    /// called.
    pub unsafe trait UnsafeFutureObj<'a, T>: 'a {
        /// Convert an owned instance into a (conceptually owned) void pointer.
        fn into_raw(self) -> *mut ();

        /// Poll the future represented by the given void pointer.
        ///
        /// # Safety
        ///
        /// The trait implementor must guarantee that it is safe to repeatedly call
        /// `poll` with the result of `into_raw` until `drop` is called; such calls
        /// are not, however, allowed to race with each other or with calls to
        /// `drop`.
        unsafe fn poll(ptr: *mut (), cx: &mut Context) -> Poll<T>;

        /// Drops the future represented by the given void pointer.
        ///
        /// # Safety
        ///
        /// The trait implementor must guarantee that it is safe to call this
        /// function once per `into_raw` invocation; that call cannot race with
        /// other calls to `drop` or `poll`.
        unsafe fn drop(ptr: *mut ());
    }

    unsafe impl<'a, T, F> UnsafeFutureObj<'a, T> for &'a mut F
        where F: Future<Output = T> + Unpin + 'a
    {
        fn into_raw(self) -> *mut () {
            self as *mut F as *mut ()
        }

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

        unsafe fn drop(_ptr: *mut ()) {}
    }

# 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`)