UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Friends | List of all members
TSharedFuture< ResultType > Class Template Reference

#include <Future.h>

+ Inheritance diagram for TSharedFuture< ResultType >:

Public Member Functions

 TSharedFuture ()=default
 
 TSharedFuture (TFuture< ResultType > &&Future)
 
ConstResultType Get () const
 
- Public Member Functions inherited from TFutureBase< ResultType >
ConstResultType Get () const
 
ConstResultType Get () const UE_LIFETIMEBOUND
 
bool IsReady () const
 
bool IsValid () const
 
void Wait () const
 
bool WaitFor (const FTimespan &Duration) const
 
bool WaitUntil (const FDateTime &Time) const
 

Friends

template<typename >
class TFuture
 

Additional Inherited Members

- Public Types inherited from TFutureBase< ResultType >
using MutableResultType = typename StateType::MutableResultType
 
using ConstResultType = typename StateType::ConstResultType
 
using RvalueResultType = typename StateType::RvalueResultType
 
- Protected Types inherited from TFutureBase< ResultType >
using StateType = TFutureState< ResultType >
 
- Protected Member Functions inherited from TFutureBase< ResultType >
 TFutureBase ()=default
 
 TFutureBase (TSharedPtr< StateType > &&InState)
 
 TFutureBase (const TSharedPtr< StateType > &InState)
 
const TSharedPtr< StateType > & GetState () const
 
template<typename Func >
auto Then (Func Continuation)
 
template<typename Func >
auto Next (Func Continuation)
 
void Reset ()
 

Detailed Description

template<typename ResultType>
class TSharedFuture< ResultType >

Template for shared futures.

Constructor & Destructor Documentation

◆ TSharedFuture() [1/2]

template<typename ResultType >
TSharedFuture< ResultType >::TSharedFuture ( )
default

Default constructor.

◆ TSharedFuture() [2/2]

template<typename ResultType >
TSharedFuture< ResultType >::TSharedFuture ( TFuture< ResultType > &&  Future)
inline

Creates and initializes a new instances from a future object.

Parameters
FutureThe future object to initialize from.

Member Function Documentation

◆ Get()

template<typename ResultType >
ConstResultType TSharedFuture< ResultType >::Get ( ) const
inline

Gets the future's result.

Returns
The result as a const reference, or the same reference if the future holds a reference, or void if the future holds a void.
Note
Not equivalent to std::future::get(). The future remains valid.

Friends And Related Symbol Documentation

◆ TFuture

template<typename ResultType >
template<typename >
friend class TFuture
friend
The documentation for this class was generated from the following file: