1. Epic GamesDeveloper
  3. TNonNullPtr

TNonNullPtr

[TNonNullPtr](API\Runtime\Core\Templates\TNonNullPtr) is a non-nullable, non-owning, raw/naked/unsafe pointer.

Unreal Engine C++ API Reference > Runtime > Core > Templates

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Templates/NonNullPointer.h
Include #include "Templates/NonNullPointer.h"

Syntax

template<typename ObjectType>  
class TNonNullPtr

Remarks

TNonNullPtr is a non-nullable, non-owning, raw/naked/unsafe pointer.

Constructors

  Type Name Description
Public function   Hack that can be used under extraordinary circumstances
Public function   Nullptr constructor - not allowed.
Public function  

TNonNullPtr ( ObjectType* InObject
)

 Constructs a non-null pointer from the provided pointer. Must not be nullptr.
Public function  

TNonNullPtr ( const gsl::not_null< OtherType >& Other
)

 Converts from gsl::not_null
Public function  

TNonNullPtr ( const TNonNullPtr< OtherObjectType >& Other
)

 Constructs a non-null pointer from another non-null pointer
Public function    

Functions

  Type Name Description
Public function Const ObjectType *

Get ()

 Returns the internal pointer
Public function Const bool WARNING: Hack that can be used under extraordinary circumstances.

Operators

  Type Name Description
Public function Const   Use IsInitialized if needed
Public function Const   Converts to a gsl::not_null
Public function Const   Returns the internal pointer
Public function Const bool

operator!= ( const TNonNullPtr& Other
)

  
Public function Const bool

operator!= ( OtherObjectType* Other
)

  
Public function Const ObjectType & Dereference operator returns a reference to the object this pointer points to
Public function TNonNullPtr &

operator= ( const gsl::not_null< OtherType >& Other
)

 Assignment operator taking a gsl::not_null
Public function TNonNullPtr &

operator= ( const TNonNullPtr< OtherObjectType >& Other
)

 Assignment operator taking another TNonNullPtr
Public function TNonNullPtr &

operator= ( ObjectType* InObject
)

 Assignment operator taking a pointer
Public function TNonNullPtr & Assignment operator taking a nullptr - not allowed.
Public function Const bool

operator== ( const TNonNullPtr& Other
)

 Comparison, will also handle default constructed state
Public function Const bool

operator== ( OtherObjectType* Other
)

 Comparison with a raw pointer
Public function Const bool  
Public function Const ObjectType * Arrow operator returns a pointer to this pointer's object

Typedefs

Name Description
IntrusiveUnsetOptionalStateType  

Constants

Name Description
bHasIntrusiveUnsetOptionalState Start - intrusive TOptional state //.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page