Ark Server API (ASE) - Wiki
Loading...
Searching...
No Matches
FString.h File Reference
#include <string>
#include <locale>
#include <Logger/Logger.h>
#include "TArray.h"
#include "../Windows/MicrosoftPlatformString.h"
#include "../Templates/MemoryOps.h"
#include "../Templates/UnrealTemplate.h"
#include "../Math/UnrealMathUtility.h"
#include "../Misc/CString.h"
#include "../Crc.h"
+ Include dependency graph for FString.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  FString
 
struct  TContainerTraits< FString >
 
struct  TIsZeroConstructType< FString >
 
struct  TTypeToString< T >
 
struct  TTypeFromString< T >
 
struct  UE4String_Private::FCompareCharsCaseSensitive
 
struct  UE4String_Private::FCompareCharsCaseInsensitive
 

Namespaces

namespace  ESearchCase
 
namespace  ESearchDir
 
namespace  Lex
 
namespace  UE4String_Private
 

Enumerations

enum  ESearchCase::Type { ESearchCase::CaseSensitive , ESearchCase::IgnoreCase }
 
enum  ESearchDir::Type { ESearchDir::FromStart , ESearchDir::FromEnd }
 

Functions

FORCEINLINE uint32 GetTypeHash (const FString &Thing)
 
 Expose_TNameOf (FString) template<> struct TIsContiguousContainer< FString >
 
TCHARGetData (FString &String)
 
const TCHARGetData (const FString &String)
 
SIZE_T GetNum (const FString &String)
 
FString BytesToString (const uint8 *In, int32 Count)
 
int32 StringToBytes (const FString &String, uint8 *OutBytes, int32 MaxBufferSize)
 
TCHAR NibbleToTChar (uint8 Num)
 
void ByteToHex (uint8 In, FString &Result)
 
FString BytesToHex (const uint8 *In, int32 Count)
 
const bool CheckTCharIsHex (const TCHAR Char)
 
const uint8 TCharToNibble (const TCHAR Char)
 
int32 HexToBytes (const FString &HexString, uint8 *OutBytes)
 
void Lex::FromString (int8 &OutValue, const TCHAR *Buffer)
 
void Lex::FromString (int16 &OutValue, const TCHAR *Buffer)
 
void Lex::FromString (int32 &OutValue, const TCHAR *Buffer)
 
void Lex::FromString (int64 &OutValue, const TCHAR *Buffer)
 
void Lex::FromString (uint8 &OutValue, const TCHAR *Buffer)
 
void Lex::FromString (uint16 &OutValue, const TCHAR *Buffer)
 
void Lex::FromString (uint32 &OutValue, const TCHAR *Buffer)
 
void Lex::FromString (uint64 &OutValue, const TCHAR *Buffer)
 
void Lex::FromString (float &OutValue, const TCHAR *Buffer)
 
void Lex::FromString (double &OutValue, const TCHAR *Buffer)
 
void Lex::FromString (FString &OutValue, const TCHAR *Buffer)
 
template<typename CharType >
TEnableIf< TIsCharType< CharType >::Value, FString >::Type Lex::ToString (const CharType *Ptr)
 
FString Lex::ToString (bool Value)
 
FORCEINLINE FString Lex::ToString (FString &&Str)
 
FORCEINLINE FString Lex::ToString (const FString &Str)
 
template<typename T >
FString Lex::ToSanitizedString (const T &Value)
 
template<typename T >
static TEnableIf< TIsArithmetic< T >::Value, bool >::Type Lex::TryParseString (T &OutValue, const TCHAR *Buffer)
 
template<typename CompareType >
bool UE4String_Private::MatchesWildcardRecursive (const TCHAR *Target, int32 TargetLength, const TCHAR *Wildcard, int32 WildcardLength)
 
int32 FindMatchingClosingParenthesis (const FString &TargetString, const int32 StartSearch)
 

Variables

static const TCHARCharToEscapeSeqMap [][2]
 
static const uint32 MaxSupportedEscapeChars = ARRAY_COUNT(CharToEscapeSeqMap)
 

Function Documentation

◆ BytesToHex()

FString BytesToHex ( const uint8 * In,
int32 Count )
inline

Convert an array of bytes to hex

Parameters
Inbyte array values to convert
Countnumber of bytes to convert
Returns
Hex value in string.

Definition at line 1755 of file FString.h.

+ Here is the call graph for this function:

◆ BytesToString()

FString BytesToString ( const uint8 * In,
int32 Count )
inline

Convert an array of bytes to a TCHAR

Parameters
Inbyte array values to convert
Countnumber of bytes to convert
Returns
Valid string representing bytes.

Definition at line 1688 of file FString.h.

+ Here is the call graph for this function:

◆ ByteToHex()

void ByteToHex ( uint8 In,
FString & Result )
inline

Convert a byte to hex

Parameters
Inbyte value to convert
Resultout hex value output

Definition at line 1743 of file FString.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ CheckTCharIsHex()

const bool CheckTCharIsHex ( const TCHAR Char)
inline

Checks if the TChar is a valid hex character

Parameters
CharThe character
Returns
True if in 0-9 and A-F ranges

Definition at line 1773 of file FString.h.

◆ Expose_TNameOf()

Expose_TNameOf ( FString )

Definition at line 1659 of file FString.h.

◆ FindMatchingClosingParenthesis()

int32 FindMatchingClosingParenthesis ( const FString & TargetString,
const int32 StartSearch )
inline

Definition at line 3011 of file FString.h.

◆ GetData() [1/2]

const TCHAR * GetData ( const FString & String)
inline

Definition at line 1672 of file FString.h.

+ Here is the call graph for this function:

◆ GetData() [2/2]

TCHAR * GetData ( FString & String)
inline

Definition at line 1667 of file FString.h.

+ Here is the call graph for this function:

◆ GetNum()

SIZE_T GetNum ( const FString & String)
inline

Definition at line 1677 of file FString.h.

+ Here is the call graph for this function:

◆ GetTypeHash()

FORCEINLINE uint32 GetTypeHash ( const FString & Thing)

Definition at line 1646 of file FString.h.

+ Here is the call graph for this function:

◆ HexToBytes()

int32 HexToBytes ( const FString & HexString,
uint8 * OutBytes )
inline

Convert FString of Hex digits into the byte array.

Parameters
HexStringThe FString of Hex values
OutBytesPtr to memory must be preallocated large enough
Returns
The number of bytes copied

Definition at line 1803 of file FString.h.

+ Here is the call graph for this function:

◆ NibbleToTChar()

TCHAR NibbleToTChar ( uint8 Num)
inline
Returns
Char value of Nibble

Definition at line 1729 of file FString.h.

+ Here is the caller graph for this function:

◆ StringToBytes()

int32 StringToBytes ( const FString & String,
uint8 * OutBytes,
int32 MaxBufferSize )
inline

Convert FString of bytes into the byte array.

Parameters
StringThe FString of byte values
OutBytesPtr to memory must be preallocated large enough
MaxBufferSizeMax buffer size of the OutBytes array, to prevent overflow
Returns
The number of bytes copied

Definition at line 1714 of file FString.h.

+ Here is the call graph for this function:

◆ TCharToNibble()

const uint8 TCharToNibble ( const TCHAR Char)
inline

Convert a TChar to equivalent hex value as a uint8

Parameters
CharThe character
Returns
The uint8 value of a hex character

Definition at line 1783 of file FString.h.

+ Here is the caller graph for this function:

Variable Documentation

◆ CharToEscapeSeqMap

const TCHAR* CharToEscapeSeqMap[][2]
static
Initial value:
=
{
{ TEXT("\\"), TEXT("\\\\") },
{ TEXT("\n"), TEXT("\\n") },
{ TEXT("\r"), TEXT("\\r") },
{ TEXT("\t"), TEXT("\\t") },
{ TEXT("\'"), TEXT("\\'") },
{ TEXT("\""), TEXT("\\\"") }
}

Definition at line 2913 of file FString.h.

◆ MaxSupportedEscapeChars

const uint32 MaxSupportedEscapeChars = ARRAY_COUNT(CharToEscapeSeqMap)
static

Definition at line 2924 of file FString.h.