std::future::LocalFutureObj - Rust
Description: API documentation for the Rust `LocalFutureObj` struct in crate `std`.
Keywords: rust, rustlang, rust-lang, LocalFutureObj

# [−][src]Struct std::future::LocalFutureObj

    pub struct LocalFutureObj<'a, T> { /* fields omitted */ }

🔬 This is a nightly-only experimental API. (`futures_api` #50547)

futures in libcore are unstable

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)

## Methods

###

`impl<'a, T> LocalFutureObj<'a, T>`

[src]

####

`pub fn new<F>(f: F) -> LocalFutureObj<'a, T> where F: 'a + UnsafeFutureObj<'a, T>,`

[src]

🔬 This is a nightly-only experimental API. (`futures_api` #50547)

futures in libcore are unstable

Create a `LocalFutureObj` from a custom trait object representation.

####

`pub unsafe fn into_future_obj(self) -> FutureObj<'a, T>`

[src]

🔬 This is a nightly-only experimental API. (`futures_api` #50547)

futures in libcore are unstable

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

## Trait Implementations

###

`impl<'a, T> Future for LocalFutureObj<'a, T>`

[src]

#### `type Output = T`

🔬 This is a nightly-only experimental API. (`futures_api` #50547)

futures in libcore are unstable

The result of the `Future`.

####

`fn poll(self: PinMut<LocalFutureObj<'a, T>>, cx: &mut Context) -> Poll<T>`

[src]

🔬 This is a nightly-only experimental API. (`futures_api` #50547)

futures in libcore are unstable

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

###

`impl<'a, T> Unpin for LocalFutureObj<'a, T>`

[src]

###

`impl<'a, T> Drop for LocalFutureObj<'a, T>`

[src]

####

`fn drop(&mut self)`

[src]

Executes the destructor for this type. Read more

###

`impl<'a, T> Debug for LocalFutureObj<'a, T>`

[src]

####

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

[src]

Formats the value using the given formatter. Read more

###

`impl<'a, T> From<FutureObj<'a, T>> for LocalFutureObj<'a, T>`

[src]

####

`fn from(f: FutureObj<'a, T>) -> LocalFutureObj<'a, T>`

[src]

Performs the conversion.

###

`impl<'a, F> From<Box<F>> for LocalFutureObj<'a, ()> where F: 'a + Future<Output = ()>,`

[src]

####

`fn from(boxed: Box<F>) -> LocalFutureObj<'a, ()>`

[src]

Performs the conversion.

###

`impl<'a, F> From<PinBox<F>> for LocalFutureObj<'a, ()> where F: 'a + Future<Output = ()>,`

[src]

####

`fn from(boxed: PinBox<F>) -> LocalFutureObj<'a, ()>`

[src]

Performs the conversion.

## Auto Trait Implementations

###

`impl<'a, T> !Send for LocalFutureObj<'a, T>`

###

`impl<'a, T> !Sync for LocalFutureObj<'a, T>`

## Blanket Implementations

###

`impl<T> From for T`

[src]

####

`fn from(t: T) -> T`

[src]

Performs the conversion.

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T, U> TryInto for T where U: TryFrom<T>,`

[src]

#### `type Error = <U as TryFrom<T>>::Error`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T, U> Into for T where U: From<T>,`

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

`impl<T> Borrow for T where T: ?Sized,`

[src]

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

`fn borrow(&self) -> &T`

[src]

Immutably borrows from an owned value. Read more

###

`impl<T> BorrowMut for T where T: ?Sized,`

[src]

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

`fn borrow_mut(&mut self) -> &mut T`

[src]

Mutably borrows from an owned value. Read more

###

`impl<T> Any for T where T: 'static + ?Sized,`

[src]

####

`fn get_type_id(&self) -> TypeId`

[src]

🔬 This is a nightly-only experimental API. (`get_type_id` #27745)

this method will likely be replaced by an associated static

Gets the `TypeId` of `self`. Read more

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