1. Epic GamesDeveloper
  3. Containers

Containers

API > API/Runtime > API/Runtime/Core

Classes

  Type Name Description
Public struct BaseKeyFuncs The base KeyFuncs type with some useful definitions for all KeyFuncs; meant to be derived from instead of used directly.  
Public struct DefaultKeyComparer Default comparer for keys in TLruCache.  
Public struct DefaultKeyFuncs A default implementation of the KeyFuncs used by TSet which uses the element as a key.  
Public class FBinaryHeap Copyright (C) 2009 Nine Realms, Inc  
Public class FBitArrayMemory    
Public class FBitReference Used to read/write a bit in the array as a bool.  
Public struct FBitSet Functions for manipulating bit sets.  
Public class FConstBitReference Used to read a bit in the array as a bool.  
Public class FContainerAllocatorInterface This is the allocation policy interface; it exists purely to document the policy's interface, and should not be used.  
Public struct FCountingOutputIterator This is a basic object which counts how many times it has been incremented  
Public class FDefaultBitArrayAllocator    
Public class FDefaultSetAllocator    
Public class FDefaultSparseArrayAllocator    
Public class FHashTable    
Public struct FIndexedLockFreeLink    
Public struct FIndexedPointer    
Public class FLazyPrintf To avoid limits with the Printf parameter count, for more readability and type safety  
Public struct FLockFreeLinkPolicy There is a version of this code that uses 128 bit atomics to avoid the indirection, that is why we have this policy class at all.  
Public class FLockFreePointerFIFOBase    
Public class FLockFreePointerListLIFOBase    
Public class FLockFreePointerListLIFORoot    
Public class FNull    
Public class FRelativeBitReference Used to reference a bit in an unspecified bit array.  
Public class FResourceArrayInterface An element type independent interface to the resource array.  
Public class FResourceBulkDataInterface Allows for direct GPU mem allocation for bulk resource types.  
Public class FScriptArray    
Public class FScriptBitArray    
Public struct FScriptContainerElement A type which is used to represent a script type that is unknown at compile time.  
Public class FScriptMap    
Public struct FScriptMapLayout    
Public class FScriptSet    
Public struct FScriptSetLayout    
Public class FScriptSparseArray    
Public struct FScriptSparseArrayLayout    
Public class FSetElementId Either NULL or an identifier for an element of a set.  
Public struct FSparseArrayAllocationInfo The result of a sparse array allocation.  
Public struct FStackTracker Stack tracker. Used to identify callstacks at any point in the codebase.  
Public class FStallingTaskQueue    
Public class FString A dynamically sizeable string.  
Public class FStringOutputDevice String output device.  
Public class FStringOutputDeviceCountLines String output device.  
Public class FTCHARToUTF8_Convert This should be replaced with Platform stuff when FPlatformString starts to know about UTF-8.  
Public struct FTextRange    
Public class FTexture2DResourceMem Allows for direct GPU mem allocation for texture resource.  
Public class FTSBackgroundableTicker This works the same as the core FTSTicker, but on supported mobile platforms it continues ticking while the app is running in the background.  
Public class FTSTicker Thread-safe ticker class. Fires delegates after a delay.  
Public class FTSTickerObjectBase Base class for thread-safe ticker objects  
Public class FUTF8ToTCHAR_Convert    
Public class TAlignedHeapAllocator The indirect allocation policy always allocates the elements indirectly.  
Public class TAlignedSparseArrayAllocator    
Public class TAllocatorFixedSizeFreeList Fixed-sized allocator that uses a free list to cache allocations.  
Public struct TAllocatorTraits    
Public struct TAllocatorTraitsBase    
Public class TArray Templated dynamic array  
Public class TArrayBuilder Template for fluent array builders.  
Public struct TArrayPrivateFriend    
Public class TArrayView Templated fixed-size view of another array  
Public class TBasicArray Basic RAII array which can be used without the excessive dependencies needed by TArray, which needs to be serialisable, have a fixed ABI, have lots of helper algorithms as members, have auto-shrinking, support allocators etc.  
Public class TBitArray A dynamically sized bit array.  
Public struct TBitsToSizeType    
Public struct TCanBulkSerialize    
Public struct TCanMoveBetweenAllocators    
Public struct TCheckedPointerIterator Pointer-like iterator type for ranged-for loops which checks that the container hasn't been resized during iteration.  
Public class TChunkedArray An array that uses multiple allocations to avoid allocation failure due to fragmentation.  
Public struct TChunkedArrayIterator    
Public class TCircularBuffer Template for circular buffers.  
Public class TCircularQueue Implements a lock-free first-in first-out queue using a circular array.  
Public class TClosableLockFreePointerListUnorderedSingleConsumer    
Public class TClosableMpscQueue Multi-producer/single-consumer unbounded concurrent queue that can be consumed only once.  
Public class TConstDualSetBitIterator Forward declaration.  
Public class TConstSetBitIterator An iterator which only iterates over set bits.  
Public class TConstStaticBitReference Used to read a bit in the static array as a bool.  
Public class TConsumeAllMpmcQueue Multi-producer/multi-consumer unbounded concurrent queue (implemented as a Stack) that is atomically consumed and is reset to its default empty state.  
Public struct TContainerElementTypeCompatibility Temporary compatibility mechanism to be used solely for the purpose of raw pointers to wrapped pointers.  
Public struct TDefaultMapHashableKeyFuncs    
Public struct TDefaultMapKeyFuncs Defines how the map's pairs are hashed.  
Public class TDeque Sequential double-ended queue (deque) container class.  
Public struct TDereferencingIterator    
Public struct TDisambiguater Used to disambiguate methods that are overloaded for all possible subtypes of a TUnion where the subtypes may not be distinct.  
Public class TDiscardableKeyValueCache Implements a thread-safe discardable Key/Value cache by using two maps - a primary and a backfill.  
Public class TDoubleLinkedList Double linked list.  
Public class TDoubleLinkedListIterator    
Public class TEnumAsByte Template to store enumeration values as bytes in a type-safe way.  
Public struct TEnumAsByte_EnumClass    
Public class TFixedAllocator The fixed allocation policy allocates up to a specified number of elements in the same allocation as the container.  
Public class TFixedSetAllocator An inline set allocator that doesn't have any secondary storage.  
Public class TFixedSparseArrayAllocator An inline sparse array allocator that doesn't have any secondary storage.  
Public class THashTable    
Public class TIndexedContainerIterator Generic iterator which can operate on types that expose the following:  
Public class TIndirectArray    
Public class TInlineSetAllocator An inline set allocator that allows sizing of the inline allocations for a set number of elements.  
Public class TInlineSparseArrayAllocator An inline sparse array allocator that allows sizing of the inline allocations for a set number of elements.  
Public class TIntrusiveDoubleLinkedList Intrusive double linked list.  
Public class TIntrusiveDoubleLinkedListIterator Forward declarations.  
Public class TIntrusiveDoubleLinkedListNode Node of an intrusive double linked list Structs/classes must inherit this, to use it, e.g: struct FMyStruct : public TIntrusiveDoubleLinkedListNode TIntrusiveDoubleLinkedListNode can be inherited multiple times, ex: if ElementType needs to be stored in several lists at once by specifying a different ContainerType template parameter to distinguish the nodes.  
Public class TIntrusiveLinkedList Encapsulates a link in a single linked list with constant access time.  
Public class TIntrusiveLinkedListIterator    
Public struct TIsCompatibleElementType Trait testing whether a type is compatible with the view type  
Public struct TIsCompatibleRangeType Trait testing whether a type is compatible with the view type  
Public struct TIsContainerElementTypeCopyable Temporary compatibility mechanism to be used solely for the purpose of raw pointers to wrapped pointers.  
Public struct TIsContainerElementTypeReinterpretable Temporary compatibility mechanism to be used solely for the purpose of raw pointers to wrapped pointers.  
Public struct TIsReinterpretableRangeType Trait testing whether a type is reinterpretable in a way that permits use with the view type  
Public struct TIsTArray    
Public struct TIsTArrayOrDerivedFromTArray    
Public struct TIsTArrayView    
Public struct TIsTEnumAsByte    
Public struct TIsTMap Traits class which determines whether or not a type is a TMap.  
Public struct TIsTSet Traits class which determines whether or not a type is a TSet.  
Public class TIteratorAdapter Adapter class for iterator implementation.  
Public class TIteratorBase TDeque iterator class.  
Public class TIteratorBase TPagedArray iterator base class for TIteratorAdapter.  
Public class TKeyInitializer An initializer type for keys that's passed to the pair set when adding a new key.  
Public class TLinkedList Encapsulates a link in a single linked list with constant access time.  
Public class TLinkedListBase Base linked list class, used to implement methods shared by intrusive/non-intrusive linked lists  
Public class TLinkedListIterator    
Public class TLinkedListIteratorBase    
Public class TList Simple single-linked list template.  
Public class TLockFreeAllocOnceIndexedAllocator    
Public class TLockFreeClassAllocator Thread safe, lock free pooling allocator of memory for instances of T.  
Public class TLockFreeClassAllocator_TLSCache Thread safe, lock free pooling allocator of memory for instances of T.  
Public class TLockFreeFixedSizeAllocator Thread safe, lock free pooling allocator of fixed size blocks that never returns free space until program shutdown.  
Public class TLockFreeFixedSizeAllocator_TLSCache Thread safe, lock free pooling allocator of fixed size blocks that never returns free space, even at shutdown alignment isn't handled, assumes FMemory::Malloc will work  
Public class TLockFreeFixedSizeAllocator_TLSCacheBase    
Public class TLockFreePointerListFIFO    
Public class TLockFreePointerListLIFO    
Public class TLockFreePointerListLIFOPad    
Public class TLockFreePointerListUnordered    
Public class TLruCache Implements a Least Recently Used (LRU) cache.  
Public class TMap A TMapBase specialization that only allows a single value associated with each key.  
Public class TMapBase The base class of maps from keys to values.  
Public class TMapBuilder Template for fluent map builders.  
Public struct TMapPrivateFriend    
Public class TMpscQueue Fast multi-producer/single-consumer unbounded concurrent queue.  
Public class TMRUArray Same as TArray except:  
Public class TMultiMap A TMapBase specialization that allows multiple values to be associated with each key.  
Public class TNonRelocatableInlineAllocator Implements a variant of TInlineAllocator with a secondary heap allocator that is allowed to store a pointer to its inline elements.  
Public class TPagedArray Fixed size block allocated container class.  
Public struct TPageTraits Page traits struct for TPagedArray.  
Public class TPairInitializer An initializer type for pairs that's passed to the pair set when adding a new pair.  
Public class TPassthruPointer This seemingly-pointless class is intended to be API-compatible with TStringPassthru and is returned by StringPassthru when no string conversion is necessary.  
Public class TQueue Template for queues.  
Public class TResourceArray A array which allocates memory which can be used for UMA rendering resources.  
Public class TRingBuffer Copyright Epic Games, Inc. All Rights Reserved.  
Public class TRingBufferIterator    
Public class TScriptArray Base dynamic array.  
Public class TScriptBitArray Untyped bit array type for accessing TBitArray data, like FScriptArray for TArray.  
Public class TScriptMap Untyped map type for accessing TMap data, like FScriptArray for TArray.  
Public class TScriptSet Untyped set type for accessing TSet data, like FScriptArray for TArray.  
Public class TScriptSparseArray Untyped sparse array type for accessing TSparseArray data, like FScriptArray for TArray.  
Public class TSet A set with an optional KeyFuncs parameters for customizing how the elements are compared and searched.  
Public class TSetAllocator Encapsulates the allocators used by a set in a single type.  
Public class TSetElement An element in the set.  
Public class TSetElementBase    
Public struct TSetPrivateFriend    
Public class TSizedDefaultAllocator 'typedefs' for various allocator defaults.  
Public class TSizedHeapAllocator The indirect allocation policy always allocates the elements indirectly.  
Public class TSizedInlineAllocator The inline allocation policy allocates up to a specified number of elements in the same allocation as the container.  
Public class TSortableMapBase The base type of sortable maps.  
Public class TSortedMap A Map of keys to value, implemented as a sorted TArray of TPairs.  
Public struct TSortedMapPrivateFriend    
Public class TSparseArray Forward declarations.  
Public class TSparseArrayAllocator Sparse array allocation definitionsEncapsulates the allocators used by a sparse array in a single type.  
Public struct TSparseArrayElementOrFreeListLink Allocated elements are overlapped with free element info in the element list.  
Public class TSpscQueue Fast single-producer/single-consumer unbounded concurrent queue.  
Public class TStaticArray An array with a static number of elements.  
Public class TStaticBitArray A statically sized bit array.  
Public class TStaticBitReference Used to read/write a bit in the static array as a bool.  
Public class TStaticHashTable    
Public class TStridedView    
Public class TStringBuilderBase String Builder  
Public class TStringBuilderWithBuffer A string builder with inline storage.  
Public class TStringConversion Class takes one type of string and converts it to another.  
Public class TStringConvert    
Public class TStringPassthru This class is returned by StringPassthru and is not intended to be used directly.  
Public class TStringPointer Class takes one type of string and and stores it as-is.  
Public class TStringView A string view is a non-owning view of a range of characters.  
Public class TTransArray NOTE: Right now, you can't use a custom allocation policy with transactional arrays.  
Public class TTripleBuffer Template for triple buffers.  
Public struct TTypeFromString    
Public struct TTypeIsCompatibleWithRangeElementType    
Public struct TTypeToString Shorthand legacy use for Lex functions  
Public class TUnion Represents a type which is the union of several other types; i.e. it can have a value whose type is of any the union's subtypes.  
Public class TUTF16ToUTF32_Convert    
Public class TUTF32ToUTF16_Convert    

Typedefs

Name Description
TArrayElementsAreCompatible Assume elements are compatible with themselves - avoids problems with generated copy constructors of arrays of forwarded types, e.g.:
TIterator  
TIterator  

Enums

  Type Name Description
Public enum UE::Core::Private::ENullTerminatedString If we don't have a platform-specific define for the TEXT macro, define it now.  
Public enum UE::EConsumeAllMpmcQueueResult Copyright Epic Games, Inc. All Rights Reserved.  

Functions

  Type Name Description
Public function decltype(auto) Simply forwards to an unqualified GetData(), but can be called from within TArrayView where GetData() is already a member and so hides any others.
Public function decltype(auto) Gets the data from the passed argument and proceeds to reinterpret the resulting elements.
Public function uint32

Freeze::IntrinsicAppendHash ( const TArray< T, AllocatorType >* DummyObject,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FSHA1& Hasher
)

  
Public function uint32

Freeze::IntrinsicAppendHash ( const THashTable< InAllocator >* DummyObject,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FSHA1& Hasher
)

  
Public function uint32

Freeze::IntrinsicAppendHash ( const TMap< KeyType, ValueType, SetAllocator, KeyFuncs >* DummyObject,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FSHA1& Hasher
)

  
Public function uint32

Freeze::IntrinsicAppendHash ( const TMultiMap< KeyType, ValueType, SetAllocator, KeyFuncs >* DummyObject,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FSHA1& Hasher
)

  
Public function uint32

Freeze::IntrinsicAppendHash ( const TSet< ElementType, KeyFuncs, Allocator >* DummyObject,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FSHA1& Hasher
)

  
Public function uint32

Freeze::IntrinsicAppendHash ( const TSparseArray< ElementType, Allocator >* DummyObject,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FSHA1& Hasher
)

  
Public function uint32

Freeze::IntrinsicGetTargetAlignment ( const TArray< T, AllocatorType >* DummyObject,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams
)

  
Public function uint32

Freeze::IntrinsicGetTargetAlignment ( const THashTable< InAllocator >* DummyObject,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams
)

  
Public function void

Freeze::IntrinsicToString ( const TArray< T, AllocatorType >& Object,
const FTypeLayoutDesc& TypeDesc,
const FPlatformTypeLayoutParameters& LayoutParams,
FMemoryToStringContext& OutContext
)

  
Public function uint32

Freeze::IntrinsicUnfrozenCopy ( const FMemoryUnfreezeContent& Context,
const TArray< T, AllocatorType >& Object,
void* OutDst
)

  
Public function uint32

Freeze::IntrinsicUnfrozenCopy ( const FMemoryUnfreezeContent& Context,
const THashTable< InAllocator >& Object,
void* OutDst
)

  
Public function uint32

Freeze::IntrinsicUnfrozenCopy ( const FMemoryUnfreezeContent& Context,
const TMap< KeyType, ValueType, SetAllocator, KeyFuncs >& Object,
void* OutDst
)

  
Public function uint32

Freeze::IntrinsicUnfrozenCopy ( const FMemoryUnfreezeContent& Context,
const TMultiMap< KeyType, ValueType, SetAllocator, KeyFuncs >& Object,
void* OutDst
)

  
Public function uint32

Freeze::IntrinsicUnfrozenCopy ( const FMemoryUnfreezeContent& Context,
const TSet< ElementType, KeyFuncs, Allocator >& Object,
void* OutDst
)

  
Public function uint32

Freeze::IntrinsicUnfrozenCopy ( const FMemoryUnfreezeContent& Context,
const TSparseArray< ElementType, Allocator >& Object,
void* OutDst
)

  
Public function void

Freeze::IntrinsicWriteMemoryImage ( FMemoryImageWriter& Writer,
const TArray< T, AllocatorType >& Object,
const FTypeLayoutDesc&
)

  
Public function void

Freeze::IntrinsicWriteMemoryImage ( FMemoryImageWriter& Writer,
const TBitArray< Allocator >& Object,
const FTypeLayoutDesc&
)

  
Public function void

Freeze::IntrinsicWriteMemoryImage ( FMemoryImageWriter& Writer,
const THashTable< InAllocator >& Object,
const FTypeLayoutDesc&
)

  
Public function void

Freeze::IntrinsicWriteMemoryImage ( FMemoryImageWriter& Writer,
const TSet< ElementType, KeyFuncs, Allocator >& Object,
const FTypeLayoutDesc&
)

  
Public function void

Freeze::IntrinsicWriteMemoryImage ( FMemoryImageWriter& Writer,
const TSparseArray< ElementType, Allocator >& Object,
const FTypeLayoutDesc&
)

  
Public function void

Freeze::IntrinsicWriteMemoryImage ( FMemoryImageWriter& Writer,
const TMap< KeyType, ValueType, SetAllocator, KeyFuncs >& Object,
const FTypeLayoutDesc&
)

  
Public function void

Freeze::IntrinsicWriteMemoryImage ( FMemoryImageWriter& Writer,
const TMultiMap< KeyType, ValueType, SetAllocator, KeyFuncs >& Object,
const FTypeLayoutDesc&
)

  
Public function void

StringConv::DecodeSurrogate ( const uint32 Codepoint,
uint16& OutHighSurrogate,
uint16& OutLowSurrogate
)

  
Public function uint32

StringConv::EncodeSurrogate ( const uint16 HighSurrogate,
const uint16 LowSurrogate
)

  
Public function FUnused  
Public function ConverterType::LegacyFromType

StringConv::GetLegacyFromType ( typename ConverterType::LegacyFromType*
)

 Helper functions for getting the conversion type from a converter.
Public function void Inline combine any UTF-16 surrogate pairs in the given string
Public function void

StringConv::InlineCombineSurrogates_Array ( TArray< TCHAR, AllocatorType >& StrBuffer
)

 Inline combine any UTF-16 surrogate pairs in the given null-terminated TCHAR array
Public function int32

StringConv::InlineCombineSurrogates_Buffer ( CharType* StrBuffer,
int32 StrLen
)

 Inline combine any UTF-16 surrogate pairs in the given null-terminated character buffer, returning the updated length
Public function bool

StringConv::IsEncodedSurrogate ( const uint32 Codepoint
)

 Is the provided Codepoint outside of the range of the basic multilingual plane, but within the valid range of UTF8/16?
Public function bool

StringConv::IsHighSurrogate ( const uint32 Codepoint
)

 Is the provided Codepoint within the range of the high-surrogates?
Public function bool

StringConv::IsLowSurrogate ( const uint32 Codepoint
)

 Is the provided Codepoint within the range of the low-surrogates?
Public function bool

StringConv::IsValidCodepoint ( const uint32 Codepoint
)

 Is the provided Codepoint within the range of valid codepoints?
Public function    
Public function FArchive &

UE::Core::PagedArray::Private::Serialize ( FArchive& Ar,
TPagedArray< ElementType, PageSizeInBytes, AllocatorType >& InOutPagedArray
)

 Serializer.
Public function void

UE::Core::PagedArray::Private::SerializeStructured ( FStructuredArchive::FSlot Slot,
TPagedArray< ElementType, PageSizeInBytes, AllocatorType >& InOutPagedArray
)

 Structured archive serializer.
Public function void

UE::Core::Private::BitwiseBinaryOperatorImpl ( const TBitArray< AllocatorA >& InA,
const TBitArray< AllocatorB >& InB,
TBitArray< OutAllocator >& OutResult,
EBitwiseOperatorFlags InFlags,
ProjectionType&& InProjection
)

  
Public function void

UE::Core::Private::BitwiseOperatorImpl ( const TBitArray< OtherAllocator >& InOther,
TBitArray< OutAllocator >& OutResult,
EBitwiseOperatorFlags InFlags,
ProjectionType&& InProjection
)

  
Public function void

UE::Core::Private::OnInvalidAlignedHeapAllocatorNum ( int32 NewNum,
SIZE_T NumBytesPerElement
)

  
Public function void

UE::Core::Private::OnInvalidArrayNum ( unsigned long long NewNum
)

  
Public function void

UE::Core::Private::OnInvalidSetNum ( unsigned long long NewNum
)

  
Public function void

UE::Core::Private::OnInvalidSizedHeapAllocatorNum ( int32 IndexSize,
int64 NewNum,
SIZE_T NumBytesPerElement
)

  
Public function constexpr auto

UE::Core::Private::StringViewGetData ( ArgTypes&&... Args
)

 Allow GetData to called unqualified from a scope with its own overload of GetData.
Public function void

UE::Deplete ( const F& Consumer
)

 Takes all items from the queue atomically and then consumes them.
Private function Static void

UE::Deplete_Internal ( FNode* First,
FNode* Last,
const F& Consumer
)

  
Public function InSizeType

UE::Deque::Private::WrapAround ( InSizeType Index,
InSizeType Range
)

 This implementation assumes that the Index value is never going to exceed twice the Range value.
Public function void

UE::Enqueue ( ArgTypes&&... Args
)

  
Public function bool

UE::EnqueueAndReturnWasEmpty ( ArgTypes&&... Args
)

  
Public function Const bool The result can be relied upon only in special cases (e.g. debug checks), as the state can change concurrently. use with caution
Public function TDepletableMpmcQueue &  
Public function TDepletableMpmcQueue &  
Public function    
Public function  

UE::TDepletableMpmcQueue ( const TDepletableMpmcQueue&
)

  
Public function  

UE::TDepletableMpmcQueue ( TDepletableMpmcQueue&&
)

  
Public function constexpr bool  
Public function decltype(auto) Simply forwards to an unqualified GetData(), but can be called from within a container or view where GetData() is already a member and so hides any others.

Variables

  Type Name Description
Public variable FNode Sentinel This concurrent queue was deprecated because it uses spin-waiting that can cause priority inversion and subsequently deadlocks on some platforms. Please use TConsumeAllMpmcQueue.
Public variable std::atomic< FNode * > Tail  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page