TFunctionRef< FuncType > Class Template Reference

#include <Function.h>

Inheritance diagram for TFunctionRef< FuncType >:

Collaboration diagram for TFunctionRef< FuncType >:

Public Member Functions
template<typename FunctorType , typename = typename TEnableIf< TAnd< TNot<TIsTFunctionRef<typename TDecay<FunctorType>::Type>>, UE::Core::Private::Function::TFuncCanBindToFunctor<FuncType, typename TDecay<FunctorType>::Type> >::Value >::Type>
	TFunctionRef (FunctorType &&InFunc UE_LIFETIMEBOUND)
	TFunctionRef (const TFunctionRef &)=default
TFunctionRef &	operator= (const TFunctionRef &) const =delete
	~TFunctionRef ()=default

Private Types
using	Super = UE::Core::Private::Function::TFunctionRefBase<UE::Core::Private::Function::FFunctionRefStoragePolicy, FuncType>

Detailed Description

template<typename FuncType>
class TFunctionRef< FuncType >

TFunctionRef<FuncType>

See the class definition for intended usage.

TFunctionRef<FuncType>

A class which represents a reference to something callable. The important part here is reference - if you bind it to a lambda and the lambda goes out of scope, you will be left with an invalid reference.

FuncType represents a function type and so TFunctionRef should be defined as follows:

// A function taking a string and float and returning int32. Parameter names are optional. TFunctionRef<int32 (const FString& Name, float Scale)>

If you also want to take ownership of the callable thing, e.g. you want to return a lambda from a function, you should use TFunction. TFunctionRef does not concern itself with ownership because it's intended to be FAST.

TFunctionRef is most useful when you want to parameterize a function with some caller-defined code without making it a template.

Example:

// Something.h void DoSomethingWithConvertingStringsToInts(TFunctionRef<int32 (const FString& Str)> Convert);

// Something.cpp void DoSomethingWithConvertingStringsToInts(TFunctionRef<int32 (const FString& Str)> Convert) { for (const FString& Str : SomeBunchOfStrings) { int32 Int = Convert(Str); DoSomething(Int); } }

// SomewhereElse.cpp #include "Something.h"

void Func() { // First do something using string length DoSomethingWithConvertingStringsToInts([](const FString& Str) { return Str.Len(); });

// Then do something using string conversion DoSomethingWithConvertingStringsToInts([](const FString& Str) { int32 Result; TTypeFromString<int32>::FromString(Result, *Str); return Result; }); }

Definition at line 769 of file Function.h.

Member Typedef Documentation

Super

template<typename FuncType >

using TFunctionRef< FuncType >::Super = UE::Core::Private::Function::TFunctionRefBase<UE::Core::Private::Function::FFunctionRefStoragePolicy, FuncType>

private

Definition at line 771 of file Function.h.

Constructor & Destructor Documentation

TFunctionRef() [1/2]

template<typename FuncType >

template<typename FunctorType , typename = typename TEnableIf< TAnd< TNot<TIsTFunctionRef<typename TDecay<FunctorType>::Type>>, UE::Core::Private::Function::TFuncCanBindToFunctor<FuncType, typename TDecay<FunctorType>::Type> >::Value >::Type>

TFunctionRef< FuncType >::TFunctionRef ( FunctorType &&InFunc UE_LIFETIMEBOUND )

inline

Constructor which binds a TFunctionRef to a callable object.

Definition at line 786 of file Function.h.

TFunctionRef() [2/2]

template<typename FuncType >

TFunctionRef< FuncType >::TFunctionRef ( const TFunctionRef< FuncType > & )

default

~TFunctionRef()

template<typename FuncType >

TFunctionRef< FuncType >::~TFunctionRef ( )

default

Member Function Documentation

operator=()

template<typename FuncType >

TFunctionRef & TFunctionRef< FuncType >::operator= ( const TFunctionRef< FuncType > & ) const

delete

---

The documentation for this class was generated from the following file:

• C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/Templates/Function.h