UE::Core::FVersePath Class Reference

#include <VersePath.h>

Public Member Functions
	FVersePath ()=default
	FVersePath (FVersePath &&)=default
	FVersePath (const FVersePath &)=default
FVersePath &	operator= (FVersePath &&)=default
FVersePath &	operator= (const FVersePath &)=default
	~FVersePath ()=default
const TCHAR *	operator* () const
bool	IsValid () const
	operator bool () const
int32	Compare (const FVersePath &Other) const
CORE_API bool	IsBaseOf (const FVersePath &Other, FStringView *OutLeafPath=nullptr) const
const FString &	ToString () const &
FString	ToString () &&
FStringView	AsStringView () const
FText	AsText () const &
FText	AsText () &&
FString	GetVerseDomain () const
FStringView	GetVerseDomainAsStringView () const
FString	GetPathExceptVerseDomain () const

Static Public Member Functions
static CORE_API bool	TryMake (FVersePath &OutPath, const FString &Path, FText *OutErrorMessage=nullptr)
static CORE_API bool	TryMake (FVersePath &OutPath, FString &&Path, FText *OutErrorMessage=nullptr)
static CORE_API bool	IsValidFullPath (const TCHAR *String, FText *OutErrorMessage=nullptr)
static CORE_API bool	IsValidFullPath (const TCHAR *String, int32 Len, FText *OutErrorMessage=nullptr)
static CORE_API bool	IsValidDomain (const TCHAR *String, FText *OutErrorMessage=nullptr)
static CORE_API bool	IsValidDomain (const TCHAR *String, int32 Len, FText *OutErrorMessage=nullptr)
static CORE_API bool	IsValidSubpath (const TCHAR *String, FText *OutErrorMessage=nullptr)
static CORE_API bool	IsValidSubpath (const TCHAR *String, int32 Len, FText *OutErrorMessage=nullptr)
static CORE_API bool	IsValidIdent (const TCHAR *String, FText *OutErrorMessage=nullptr, const FText *IdentTermReplacement=nullptr)
static CORE_API bool	IsValidIdent (const TCHAR *String, int32 Len, FText *OutErrorMessage=nullptr, const FText *IdentTermReplacement=nullptr)

Friends
bool	operator== (const FVersePath &Lhs, const FVersePath &Rhs)
bool	operator!= (const FVersePath &Lhs, const FVersePath &Rhs)
FArchive &	operator<< (FArchive &Ar, FVersePath &VersePath)

Constructor & Destructor Documentation

FVersePath() [1/3]

UE::Core::FVersePath::FVersePath ( )

default

FVersePath() [2/3]

UE::Core::FVersePath::FVersePath ( FVersePath &&  )

default

FVersePath() [3/3]

UE::Core::FVersePath::FVersePath ( const FVersePath &  )

default

~FVersePath()

UE::Core::FVersePath::~FVersePath ( )

default

Member Function Documentation

AsStringView()

FStringView UE::Core::FVersePath::AsStringView ( ) const

inline

AsText() [1/2]

FText UE::Core::FVersePath::AsText ( ) &&

inline

AsText() [2/2]

FText UE::Core::FVersePath::AsText ( ) const &

inline

Compare()

int32 UE::Core::FVersePath::Compare ( const FVersePath &  Other ) const

inline

Lexicographically tests how this Verse path compares to the Other given Verse path

Parameters

Other

The Verse path to test against

Returns

0 if equal, negative if less than, positive if greater than

GetPathExceptVerseDomain()

FString UE::Core::FVersePath::GetPathExceptVerseDomain ( ) const

inline

GetVerseDomain()

FString UE::Core::FVersePath::GetVerseDomain ( ) const

inline

GetVerseDomainAsStringView()

FStringView UE::Core::FVersePath::GetVerseDomainAsStringView ( ) const

inline

IsBaseOf()

bool UE::Core::FVersePath::IsBaseOf	(	const FVersePath &	Other,
		FStringView *	OutLeafPath = nullptr
	)		const

Tests whether this Verse path is a base Verse path of Other

Examples: "/domain1/path1", "/domain1/path1" -> true, "" "/domain1/path1", "/domain1/path1/leaf" -> true, "leaf" "/domain1/path1", "/domain1/path1/path2/leaf" -> true, "path2/leaf" "/domain1/path1", "/domain1/path2/leaf" -> false, "" "/domain1/path1", "/domain2/path1/leaf" -> false, ""

Parameters

Other	The Verse path to test against
OutLeafPath	The path segment of Other that is relative to this Verse path, ommiting the leading '/'. Empty if the two Verse paths are equal

Returns

true if Other is relative or equal to this Verse path

IsValid()

bool UE::Core::FVersePath::IsValid ( ) const

inline

IsValidDomain() [1/2]

bool UE::Core::FVersePath::IsValidDomain ( const TCHAR *  String, FText *  OutErrorMessage = nullptr  )

static

IsValidDomain() [2/2]

bool UE::Core::FVersePath::IsValidDomain ( const TCHAR *  String, int32  Len, FText *  OutErrorMessage = nullptr  )

static

IsValidFullPath() [1/2]

bool UE::Core::FVersePath::IsValidFullPath ( const TCHAR *  String, FText *  OutErrorMessage = nullptr  )

static

IsValidFullPath() [2/2]

bool UE::Core::FVersePath::IsValidFullPath ( const TCHAR *  String, int32  Len, FText *  OutErrorMessage = nullptr  )

static

IsValidIdent() [1/2]

bool UE::Core::FVersePath::IsValidIdent ( const TCHAR *  String, FText *  OutErrorMessage = nullptr, const FText *  IdentTermReplacement = nullptr  )

static

IsValidIdent() [2/2]

bool UE::Core::FVersePath::IsValidIdent ( const TCHAR *  String, int32  Len, FText *  OutErrorMessage = nullptr, const FText *  IdentTermReplacement = nullptr  )

static

IsValidSubpath() [1/2]

bool UE::Core::FVersePath::IsValidSubpath ( const TCHAR *  String, FText *  OutErrorMessage = nullptr  )

static

IsValidSubpath() [2/2]

bool UE::Core::FVersePath::IsValidSubpath ( const TCHAR *  String, int32  Len, FText *  OutErrorMessage = nullptr  )

static

operator bool()

UE::Core::FVersePath::operator bool ( ) const

inlineexplicit

operator*()

const TCHAR * UE::Core::FVersePath::operator* ( ) const

inline

operator=() [1/2]

FVersePath & UE::Core::FVersePath::operator= ( const FVersePath &  )

default

operator=() [2/2]

FVersePath & UE::Core::FVersePath::operator= ( FVersePath &&  )

default

ToString() [1/2]

FString UE::Core::FVersePath::ToString ( ) &&

inline

ToString() [2/2]

const FString & UE::Core::FVersePath::ToString ( ) const &

inline

TryMake() [1/2]

bool UE::Core::FVersePath::TryMake ( FVersePath &  OutPath, const FString &  Path, FText *  OutErrorMessage = nullptr  )

static

TryMake() [2/2]

bool UE::Core::FVersePath::TryMake ( FVersePath &  OutPath, FString &&  Path, FText *  OutErrorMessage = nullptr  )

static

Friends And Related Symbol Documentation

operator!=

bool operator!= ( const FVersePath &  Lhs, const FVersePath &  Rhs  )

friend

operator<<

FArchive & operator<< ( FArchive &  Ar, FVersePath &  VersePath  )

friend

operator==

bool operator== ( const FVersePath &  Lhs, const FVersePath &  Rhs  )

friend

---

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

• Engine/Source/Runtime/Core/Public/Containers/VersePath.h
• Engine/Source/Runtime/Core/Private/Containers/VersePath.cpp