1. Epic GamesDeveloper
  3. FSharedStruct

FSharedStruct

[FSharedStruct](API\Plugins\StructUtils\FSharedStruct) works similarly as a TSharedPtr but avoids the double pointer indirection.

API > API/Plugins > API/Plugins/StructUtils

References

   
Module StructUtils
Header /Engine/Plugins/Experimental/StructUtils/Source/StructUtils/Public/SharedStruct.h
Include #include "SharedStruct.h"

Syntax

USTRUCT&40;&41;  
struct FSharedStruct

Remarks

FSharedStruct works similarly as a TSharedPtr but avoids the double pointer indirection. (One pointer for the FInstancedStruct and one pointer for the struct memory it is wrapping). Also note that because of its implementation, it is not possible for now to go from a struct reference or struct view back to a shared struct.

This struct type is also convertible to a FStructView / FConstStructView and like FInstancedStruct it is the preferable way of passing it as a parameter. If the calling code would like to keep a shared pointer to the struct, you may pass the FSharedStruct as a parameter but it is recommended to pass it as a "const FSharedStruct&" to limit the unnecessary recounting.

A 'const FSharedStruct' can not be made to point at another instance of a struct, whilst a vanila FSharedStruct can. In either case the shared struct memory /data is mutable.

Variables

  Type Name Description
Protected variable TSharedPtr< FStructSharedMemory > StructMemoryPtr  

Constructors

  Type Name Description
Public function    
Public function  

FSharedStruct ( const FConstStructView& InOther
)

 Use Make() or InitializeAs() instead
Public function  

FSharedStruct ( const FSharedStruct& InOther
)

 Copy constructors
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void  
Public function Const T &

Get ()

 Returns reference to the struct, this getter assumes that all data is valid.
Public function Const uint8 * Returns a mutable pointer to struct memory.
Public function Const T *

GetPtr ()

 Returns pointer to the struct, or nullptr if cast is not valid.
Public function Const const UScriptStruct * Returns struct type.
Public function Const TObjectPtr< const UScriptStruct > *const  
Public function Const bool

Identical ( const FSharedStruct* Other,
uint32 PortFlags
)

 For StructOpsTypeTraits
Public function void

InitializeAs ( const T& Struct
)

 Initializes from templated struct instance.
Public function void

InitializeAs ( const UScriptStruct* InScriptStruct,
const uint8* InStructMemory
)

 Initializes from struct type and optional data.
Public function void

InitializeAs ( TArgs&&... InArgs
)

 Initializes from struct type and emplace args.
Public function void

InitializeAs ( const T& Struct
)

 Initializes from other related struct types.
Public function void Initializes from templated struct type.
Public function Const bool

IsValid ()

 Returns True if the struct is valid.
Public function Static FSharedStruct

Make ()

 Creates a new FSharedStruct from templated struct type.
Public function Static FSharedStruct

Make ( const T& Struct
)

 Creates a new FSharedStruct from templated struct instance.
Public function Static FSharedStruct

Make ( TArgs&&... InArgs
)

 Creates a new FSharedStruct from the templated type and forward all arguments to constructor.
Public function Static FSharedStruct

Make ( const UScriptStruct* InScriptStruct,
const uint8* InStructMemory
)

 Creates a new FSharedStruct from struct type and optional instance memory.
Public function void

Reset ()

 Reset to empty.

Operators

  Type Name Description
Public function Const bool

operator!= ( const OtherType& Other
)

  
Public function FSharedStruct &

operator= ( const FSharedStruct& InOther
)

 Assignment operators
Public function FSharedStruct &

operator= ( FSharedStruct&& InOther
)

  
Public function Const bool

operator== ( const OtherType& Other
)

 Comparison operators. Note: it does not compare the internal structure itself

Deprecated Functions

  Type Name Description
Public function  

FSharedStruct ( const FConstStructView& InOther
)

 Use Make() or InitializeAs() instead
Public function T & Use Get() instead
Public function uint8 * Use GetMemory() instead
Public function T * Use GetPtr() instead
Public function FSharedStruct &

operator= ( const FConstStructView& InOther
)

 Use Make() instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page