UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::String Namespace Reference

Namespaces

namespace  Private
 

Enumerations

enum class  EParseLinesOptions : uint32 { None = 0 , SkipEmpty = 1 << 0 , Trim = 1 << 1 }
 
enum class  EParseTokensOptions : uint32 { None = 0 , IgnoreCase = 1 << 0 , SkipEmpty = 1 << 1 , Trim = 1 << 2 }
 

Functions

void BytesToHex (TConstArrayView< uint8 > Bytes, ANSICHAR *OutHex)
 
void BytesToHex (TConstArrayView< uint8 > Bytes, WIDECHAR *OutHex)
 
void BytesToHex (TConstArrayView< uint8 > Bytes, UTF8CHAR *OutHex)
 
void BytesToHexLower (TConstArrayView< uint8 > Bytes, ANSICHAR *OutHex)
 
void BytesToHexLower (TConstArrayView< uint8 > Bytes, WIDECHAR *OutHex)
 
void BytesToHexLower (TConstArrayView< uint8 > Bytes, UTF8CHAR *OutHex)
 
void BytesToHex (TConstArrayView< uint8 > Bytes, FAnsiStringBuilderBase &Builder)
 
void BytesToHex (TConstArrayView< uint8 > Bytes, FWideStringBuilderBase &Builder)
 
void BytesToHex (TConstArrayView< uint8 > Bytes, FUtf8StringBuilderBase &Builder)
 
void BytesToHexLower (TConstArrayView< uint8 > Bytes, FAnsiStringBuilderBase &Builder)
 
void BytesToHexLower (TConstArrayView< uint8 > Bytes, FWideStringBuilderBase &Builder)
 
void BytesToHexLower (TConstArrayView< uint8 > Bytes, FUtf8StringBuilderBase &Builder)
 
void UpperCaseTo (FAnsiStringView Input, FAnsiStringBuilderBase &Output)
 
void UpperCaseTo (FUtf8StringView Input, FUtf8StringBuilderBase &Output)
 
void UpperCaseTo (FWideStringView Input, FWideStringBuilderBase &Output)
 
void LowerCaseTo (FAnsiStringView Input, FAnsiStringBuilderBase &Output)
 
void LowerCaseTo (FUtf8StringView Input, FUtf8StringBuilderBase &Output)
 
void LowerCaseTo (FWideStringView Input, FWideStringBuilderBase &Output)
 
void PascalCaseTo (FStringView Input, FStringBuilderBase &Output)
 
void EscapeTo (FStringView Input, FStringBuilderBase &Output)
 
void QuoteEscapeTo (FStringView Input, FStringBuilderBase &Output)
 
int32 FindFirst (FUtf8StringView View, FUtf8StringView Search, ESearchCase::Type SearchCase)
 
int32 FindFirst (FWideStringView View, FWideStringView Search, ESearchCase::Type SearchCase)
 
int32 FindLast (FUtf8StringView View, FUtf8StringView Search, ESearchCase::Type SearchCase)
 
int32 FindLast (FWideStringView View, FWideStringView Search, ESearchCase::Type SearchCase)
 
int32 FindFirstOfAny (FAnsiStringView View, TConstArrayView< FAnsiStringView > Search, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
int32 FindFirstOfAny (FUtf8StringView View, TConstArrayView< FUtf8StringView > Search, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
int32 FindFirstOfAny (FWideStringView View, TConstArrayView< FWideStringView > Search, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
int32 FindLastOfAny (FAnsiStringView View, TConstArrayView< FAnsiStringView > Search, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
int32 FindLastOfAny (FUtf8StringView View, TConstArrayView< FUtf8StringView > Search, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
int32 FindLastOfAny (FWideStringView View, TConstArrayView< FWideStringView > Search, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
int32 FindFirstChar (FUtf8StringView View, UTF8CHAR Search, ESearchCase::Type SearchCase)
 
int32 FindFirstChar (FWideStringView View, WIDECHAR Search, ESearchCase::Type SearchCase)
 
int32 FindLastChar (FUtf8StringView View, UTF8CHAR Search, ESearchCase::Type SearchCase)
 
int32 FindLastChar (FWideStringView View, WIDECHAR Search, ESearchCase::Type SearchCase)
 
int32 FindFirstOfAnyChar (FUtf8StringView View, std::initializer_list< UTF8CHAR > Search, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
int32 FindFirstOfAnyChar (FUtf8StringView View, TConstArrayView< ANSICHAR > Search, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
int32 FindFirstOfAnyChar (FUtf8StringView View, TConstArrayView< UTF8CHAR > Search, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
int32 FindFirstOfAnyChar (FWideStringView View, TConstArrayView< WIDECHAR > Search, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
int32 FindLastOfAnyChar (FUtf8StringView View, std::initializer_list< UTF8CHAR > Search, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
int32 FindLastOfAnyChar (FUtf8StringView View, TConstArrayView< ANSICHAR > Search, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
int32 FindLastOfAnyChar (FUtf8StringView View, TConstArrayView< UTF8CHAR > Search, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
int32 FindLastOfAnyChar (FWideStringView View, TConstArrayView< WIDECHAR > Search, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
int32 HexToBytes (FWideStringView Hex, uint8 *OutBytes)
 
int32 HexToBytes (FUtf8StringView Hex, uint8 *OutBytes)
 
CORE_API FString FromHostLineEndings (const FString &InString)
 
CORE_API FString FromHostLineEndings (FString &&InString)
 
CORE_API void FromHostLineEndingsInline (FString &InString)
 
CORE_API FString ToHostLineEndings (const FString &InString)
 
CORE_API FString ToHostLineEndings (FString &&InString)
 
CORE_API void ToHostLineEndingsInline (FString &InString)
 
bool IsNumeric (FWideStringView View)
 
bool IsNumeric (FUtf8StringView View)
 
bool IsNumericOnlyDigits (FWideStringView View)
 
bool IsNumericOnlyDigits (FUtf8StringView View)
 
void ParseLines (FWideStringView View, TFunctionRef< void(FWideStringView)> Visitor, EParseLinesOptions Options)
 
void ParseLines (FUtf8StringView View, TFunctionRef< void(FUtf8StringView)> Visitor, EParseLinesOptions Options)
 
void ParseTokens (const FAnsiStringView View, const ANSICHAR Delimiter, TFunctionRef< void(FAnsiStringView)> Visitor, const EParseTokensOptions Options)
 
void ParseTokens (const FWideStringView View, const WIDECHAR Delimiter, TFunctionRef< void(FWideStringView)> Visitor, const EParseTokensOptions Options)
 
void ParseTokens (const FUtf8StringView View, const UTF8CHAR Delimiter, TFunctionRef< void(FUtf8StringView)> Visitor, const EParseTokensOptions Options)
 
void ParseTokens (const FAnsiStringView View, const FAnsiStringView Delimiter, TFunctionRef< void(FAnsiStringView)> Visitor, const EParseTokensOptions Options)
 
void ParseTokens (const FWideStringView View, const FWideStringView Delimiter, TFunctionRef< void(FWideStringView)> Visitor, const EParseTokensOptions Options)
 
void ParseTokens (const FUtf8StringView View, const FUtf8StringView Delimiter, TFunctionRef< void(FUtf8StringView)> Visitor, const EParseTokensOptions Options)
 
void ParseTokensMultiple (const FAnsiStringView View, const TConstArrayView< ANSICHAR > Delimiters, TFunctionRef< void(FAnsiStringView)> Visitor, const EParseTokensOptions Options)
 
void ParseTokensMultiple (const FWideStringView View, const TConstArrayView< WIDECHAR > Delimiters, TFunctionRef< void(FWideStringView)> Visitor, const EParseTokensOptions Options)
 
void ParseTokensMultiple (const FUtf8StringView View, const TConstArrayView< UTF8CHAR > Delimiters, TFunctionRef< void(FUtf8StringView)> Visitor, const EParseTokensOptions Options)
 
void ParseTokensMultiple (const FAnsiStringView View, const TConstArrayView< FAnsiStringView > Delimiters, TFunctionRef< void(FAnsiStringView)> Visitor, const EParseTokensOptions Options)
 
void ParseTokensMultiple (const FWideStringView View, const TConstArrayView< FWideStringView > Delimiters, TFunctionRef< void(FWideStringView)> Visitor, const EParseTokensOptions Options)
 
void ParseTokensMultiple (const FUtf8StringView View, const TConstArrayView< FUtf8StringView > Delimiters, TFunctionRef< void(FUtf8StringView)> Visitor, const EParseTokensOptions Options)
 
bool SplitFirst (FAnsiStringView View, FAnsiStringView Search, FAnsiStringView &OutLeft, FAnsiStringView &OutRight, ESearchCase::Type SearchCase)
 
bool SplitFirst (FUtf8StringView View, FUtf8StringView Search, FUtf8StringView &OutLeft, FUtf8StringView &OutRight, ESearchCase::Type SearchCase)
 
bool SplitFirst (FWideStringView View, FWideStringView Search, FWideStringView &OutLeft, FWideStringView &OutRight, ESearchCase::Type SearchCase)
 
bool SplitLast (FAnsiStringView View, FAnsiStringView Search, FAnsiStringView &OutLeft, FAnsiStringView &OutRight, ESearchCase::Type SearchCase)
 
bool SplitLast (FUtf8StringView View, FUtf8StringView Search, FUtf8StringView &OutLeft, FUtf8StringView &OutRight, ESearchCase::Type SearchCase)
 
bool SplitLast (FWideStringView View, FWideStringView Search, FWideStringView &OutLeft, FWideStringView &OutRight, ESearchCase::Type SearchCase)
 
bool SplitFirstOfAny (FAnsiStringView View, TConstArrayView< FAnsiStringView > Search, FAnsiStringView &OutLeft, FAnsiStringView &OutRight, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
bool SplitFirstOfAny (FUtf8StringView View, TConstArrayView< FUtf8StringView > Search, FUtf8StringView &OutLeft, FUtf8StringView &OutRight, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
bool SplitFirstOfAny (FWideStringView View, TConstArrayView< FWideStringView > Search, FWideStringView &OutLeft, FWideStringView &OutRight, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
bool SplitLastOfAny (FAnsiStringView View, TConstArrayView< FAnsiStringView > Search, FAnsiStringView &OutLeft, FAnsiStringView &OutRight, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
bool SplitLastOfAny (FUtf8StringView View, TConstArrayView< FUtf8StringView > Search, FUtf8StringView &OutLeft, FUtf8StringView &OutRight, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
bool SplitLastOfAny (FWideStringView View, TConstArrayView< FWideStringView > Search, FWideStringView &OutLeft, FWideStringView &OutRight, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
bool SplitFirstChar (FAnsiStringView View, ANSICHAR Search, FAnsiStringView &OutLeft, FAnsiStringView &OutRight, ESearchCase::Type SearchCase)
 
bool SplitFirstChar (FUtf8StringView View, UTF8CHAR Search, FUtf8StringView &OutLeft, FUtf8StringView &OutRight, ESearchCase::Type SearchCase)
 
bool SplitFirstChar (FWideStringView View, WIDECHAR Search, FWideStringView &OutLeft, FWideStringView &OutRight, ESearchCase::Type SearchCase)
 
bool SplitLastChar (FAnsiStringView View, ANSICHAR Search, FAnsiStringView &OutLeft, FAnsiStringView &OutRight, ESearchCase::Type SearchCase)
 
bool SplitLastChar (FUtf8StringView View, UTF8CHAR Search, FUtf8StringView &OutLeft, FUtf8StringView &OutRight, ESearchCase::Type SearchCase)
 
bool SplitLastChar (FWideStringView View, WIDECHAR Search, FWideStringView &OutLeft, FWideStringView &OutRight, ESearchCase::Type SearchCase)
 
bool SplitFirstOfAnyChar (FAnsiStringView View, TConstArrayView< ANSICHAR > Search, FAnsiStringView &OutLeft, FAnsiStringView &OutRight, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
bool SplitFirstOfAnyChar (FUtf8StringView View, TConstArrayView< UTF8CHAR > Search, FUtf8StringView &OutLeft, FUtf8StringView &OutRight, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
bool SplitFirstOfAnyChar (FWideStringView View, TConstArrayView< WIDECHAR > Search, FWideStringView &OutLeft, FWideStringView &OutRight, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
bool SplitLastOfAnyChar (FAnsiStringView View, TConstArrayView< ANSICHAR > Search, FAnsiStringView &OutLeft, FAnsiStringView &OutRight, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
bool SplitLastOfAnyChar (FUtf8StringView View, TConstArrayView< UTF8CHAR > Search, FUtf8StringView &OutLeft, FUtf8StringView &OutRight, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
bool SplitLastOfAnyChar (FWideStringView View, TConstArrayView< WIDECHAR > Search, FWideStringView &OutLeft, FWideStringView &OutRight, ESearchCase::Type SearchCase, int32 *OutMatchIndex)
 
Private::TUpperCase< ANSICHARUpperCase (FAnsiStringView Input)
 
Private::TUpperCase< UTF8CHARUpperCase (FUtf8StringView Input)
 
Private::TUpperCase< WIDECHARUpperCase (FWideStringView Input)
 
Private::TLowerCase< ANSICHARLowerCase (FAnsiStringView Input)
 
Private::TLowerCase< UTF8CHARLowerCase (FUtf8StringView Input)
 
Private::TLowerCase< WIDECHARLowerCase (FWideStringView Input)
 
Private::TPascalCase< TCHARPascalCase (FStringView Input)
 
Private::FEscape Escape (FStringView Input)
 
Private::FQuoteEscape QuoteEscape (FStringView Input)
 
template<typename RangeType , typename ProjectionType , typename DelimiterType , typename QuoteType >
auto JoinQuotedBy (RangeType &&Range, ProjectionType Projection, DelimiterType &&Delimiter, QuoteType &&Quote) -> Private::TJoinQuotedBy< RangeType, ProjectionType, DelimiterType, QuoteType >
 
template<typename RangeType , typename ProjectionType , typename DelimiterType , typename QuoteType , typename CharType >
TStringBuilderBase< CharType > & JoinQuotedByTo (RangeType &&Range, ProjectionType Projection, DelimiterType &&Delimiter, QuoteType &&Quote, TStringBuilderBase< CharType > &Builder)
 
template<typename RangeType , typename DelimiterType , typename QuoteType >
auto JoinQuoted (RangeType &&Range, DelimiterType &&Delimiter, QuoteType &&Quote) -> Private::TJoinQuotedBy< RangeType, FIdentityFunctor, DelimiterType, QuoteType >
 
template<typename RangeType , typename DelimiterType , typename QuoteType , typename CharType >
TStringBuilderBase< CharType > & JoinQuotedTo (RangeType &&Range, DelimiterType &&Delimiter, QuoteType &&Quote, TStringBuilderBase< CharType > &Builder)
 
template<typename RangeType , typename ProjectionType , typename DelimiterType >
auto JoinBy (RangeType &&Range, ProjectionType Projection, DelimiterType &&Delimiter) -> Private::TJoinBy< RangeType, ProjectionType, DelimiterType >
 
template<typename RangeType , typename ProjectionType , typename DelimiterType , typename CharType >
TStringBuilderBase< CharType > & JoinByTo (RangeType &&Range, ProjectionType Projection, DelimiterType &&Delimiter, TStringBuilderBase< CharType > &Builder)
 
template<typename RangeType , typename DelimiterType >
auto Join (RangeType &&Range, DelimiterType &&Delimiter) -> Private::TJoinBy< RangeType, FIdentityFunctor, DelimiterType >
 
template<typename RangeType , typename DelimiterType , typename CharType >
TStringBuilderBase< CharType > & JoinTo (RangeType &&Range, DelimiterType &&Delimiter, TStringBuilderBase< CharType > &Builder)
 
template<typename TupleType , typename ProjectionType , typename DelimiterType , typename QuoteType >
auto JoinTupleQuotedBy (TupleType &&Tuple, ProjectionType Projection, DelimiterType &&Delimiter, QuoteType &&Quote) -> Private::TJoinTupleQuotedBy< TupleType, ProjectionType, DelimiterType, QuoteType >
 
template<typename TupleType , typename ProjectionType , typename DelimiterType , typename QuoteType , typename CharType UE_REQUIRES>
TStringBuilderBase< CharType > & JoinTupleQuotedByTo (TupleType &&Tuple, ProjectionType Projection, DelimiterType &&Delimiter, QuoteType &&Quote, TStringBuilderBase< CharType > &Builder)
 
template<typename TupleType , typename DelimiterType , typename QuoteType >
auto JoinTupleQuoted (TupleType &&Tuple, DelimiterType &&Delimiter, QuoteType &&Quote) -> Private::TJoinTupleQuotedBy< TupleType, FIdentityFunctor, DelimiterType, QuoteType >
 
template<typename TupleType , typename DelimiterType , typename QuoteType , typename CharType >
TStringBuilderBase< CharType > & JoinTupleQuotedTo (TupleType &&Tuple, DelimiterType &&Delimiter, QuoteType &&Quote, TStringBuilderBase< CharType > &Builder)
 
template<typename TupleType , typename ProjectionType , typename DelimiterType >
auto JoinTupleBy (TupleType &&Tuple, ProjectionType Projection, DelimiterType &&Delimiter) -> Private::TJoinTupleBy< TupleType, ProjectionType, DelimiterType >
 
template<typename TupleType , typename ProjectionType , typename DelimiterType , typename CharType UE_REQUIRES>
TStringBuilderBase< CharType > & JoinTupleByTo (TupleType &&Tuple, ProjectionType Projection, DelimiterType &&Delimiter, TStringBuilderBase< CharType > &Builder)
 
template<typename TupleType , typename DelimiterType >
auto JoinTuple (TupleType &&Tuple, DelimiterType &&Delimiter) -> Private::TJoinTupleBy< TupleType, FIdentityFunctor, DelimiterType >
 
template<typename TupleType , typename DelimiterType , typename CharType >
TStringBuilderBase< CharType > & JoinTupleTo (TupleType &&Tuple, DelimiterType &&Delimiter, TStringBuilderBase< CharType > &Builder)
 
 ENUM_CLASS_FLAGS (EParseLinesOptions)
 
template<typename OutputType , typename StringViewType >
void ParseLines (const StringViewType View, OutputType &Output, const EParseLinesOptions Options=EParseLinesOptions::None)
 
 ENUM_CLASS_FLAGS (EParseTokensOptions)
 
template<typename OutputType >
void ParseTokens (const FAnsiStringView View, const ANSICHAR Delimiter, OutputType &Output, const EParseTokensOptions Options=EParseTokensOptions::None)
 
template<typename OutputType >
void ParseTokens (const FWideStringView View, const WIDECHAR Delimiter, OutputType &Output, const EParseTokensOptions Options=EParseTokensOptions::None)
 
template<typename OutputType >
void ParseTokens (const FUtf8StringView View, const UTF8CHAR Delimiter, OutputType &Output, const EParseTokensOptions Options=EParseTokensOptions::None)
 
template<typename OutputType >
void ParseTokens (const FAnsiStringView View, const FAnsiStringView Delimiter, OutputType &Output, const EParseTokensOptions Options=EParseTokensOptions::None)
 
template<typename OutputType >
void ParseTokens (const FWideStringView View, const FWideStringView Delimiter, OutputType &Output, const EParseTokensOptions Options=EParseTokensOptions::None)
 
template<typename OutputType >
void ParseTokens (const FUtf8StringView View, const FUtf8StringView Delimiter, OutputType &Output, const EParseTokensOptions Options=EParseTokensOptions::None)
 
template<typename OutputType >
void ParseTokensMultiple (const FAnsiStringView View, const TConstArrayView< ANSICHAR > Delimiters, OutputType &Output, const EParseTokensOptions Options=EParseTokensOptions::None)
 
template<typename OutputType >
void ParseTokensMultiple (const FWideStringView View, const TConstArrayView< WIDECHAR > Delimiters, OutputType &Output, const EParseTokensOptions Options=EParseTokensOptions::None)
 
template<typename OutputType >
void ParseTokensMultiple (const FUtf8StringView View, const TConstArrayView< UTF8CHAR > Delimiters, OutputType &Output, const EParseTokensOptions Options=EParseTokensOptions::None)
 
template<typename OutputType >
void ParseTokensMultiple (const FAnsiStringView View, const TConstArrayView< FAnsiStringView > Delimiters, OutputType &Output, const EParseTokensOptions Options=EParseTokensOptions::None)
 
template<typename OutputType >
void ParseTokensMultiple (const FWideStringView View, const TConstArrayView< FWideStringView > Delimiters, OutputType &Output, const EParseTokensOptions Options=EParseTokensOptions::None)
 
template<typename OutputType >
void ParseTokensMultiple (const FUtf8StringView View, const TConstArrayView< FUtf8StringView > Delimiters, OutputType &Output, const EParseTokensOptions Options=EParseTokensOptions::None)
 
template<typename CharType >
TStringView< CharType > RemoveFromStart (const TStringView< CharType > View, const TStringView< CharType > Prefix, ESearchCase::Type SearchCase=ESearchCase::CaseSensitive)
 
template<typename CharType >
TStringView< CharType > RemoveFromEnd (const TStringView< CharType > View, const TStringView< CharType > Prefix, ESearchCase::Type SearchCase=ESearchCase::CaseSensitive)
 

Enumeration Type Documentation

◆ EParseLinesOptions

Enumerator
None 

Use the default options when parsing lines.

SkipEmpty 

Skip lines that are empty or, if trimming, only whitespace.

Trim 

Trim whitespace from each parsed line.

◆ EParseTokensOptions

Enumerator
None 

Use the default options when parsing tokens.

IgnoreCase 

Ignore case when comparing delimiters against the string.

SkipEmpty 

Skip tokens that are empty or, if trimming, only whitespace.

Trim 

Trim whitespace from each parsed token.

Function Documentation

◆ BytesToHex() [1/6]

CORE_API void UE::String::BytesToHex ( TConstArrayView< uint8 Bytes,
ANSICHAR OutHex 
)

Convert an array of bytes to a non-null-terminated string of hex digits.

Parameters
BytesArray of bytes to convert.
OutHex[out] Array of at least 2*Bytes.Len() output characters.

◆ BytesToHex() [2/6]

CORE_API void UE::String::BytesToHex ( TConstArrayView< uint8 Bytes,
FAnsiStringBuilderBase Builder 
)

Append an array of bytes to a string builder as hex digits.

Parameters
BytesArray of bytes to convert.
BuilderBuilder to append the converted string to.

◆ BytesToHex() [3/6]

CORE_API void UE::String::BytesToHex ( TConstArrayView< uint8 Bytes,
FUtf8StringBuilderBase Builder 
)

◆ BytesToHex() [4/6]

CORE_API void UE::String::BytesToHex ( TConstArrayView< uint8 Bytes,
FWideStringBuilderBase Builder 
)

◆ BytesToHex() [5/6]

CORE_API void UE::String::BytesToHex ( TConstArrayView< uint8 Bytes,
UTF8CHAR OutHex 
)

◆ BytesToHex() [6/6]

CORE_API void UE::String::BytesToHex ( TConstArrayView< uint8 Bytes,
WIDECHAR OutHex 
)

◆ BytesToHexLower() [1/6]

CORE_API void UE::String::BytesToHexLower ( TConstArrayView< uint8 Bytes,
ANSICHAR OutHex 
)

◆ BytesToHexLower() [2/6]

CORE_API void UE::String::BytesToHexLower ( TConstArrayView< uint8 Bytes,
FAnsiStringBuilderBase Builder 
)

◆ BytesToHexLower() [3/6]

CORE_API void UE::String::BytesToHexLower ( TConstArrayView< uint8 Bytes,
FUtf8StringBuilderBase Builder 
)

◆ BytesToHexLower() [4/6]

CORE_API void UE::String::BytesToHexLower ( TConstArrayView< uint8 Bytes,
FWideStringBuilderBase Builder 
)

◆ BytesToHexLower() [5/6]

CORE_API void UE::String::BytesToHexLower ( TConstArrayView< uint8 Bytes,
UTF8CHAR OutHex 
)

◆ BytesToHexLower() [6/6]

CORE_API void UE::String::BytesToHexLower ( TConstArrayView< uint8 Bytes,
WIDECHAR OutHex 
)

◆ ENUM_CLASS_FLAGS() [1/2]

UE::String::ENUM_CLASS_FLAGS ( EParseLinesOptions  )

◆ ENUM_CLASS_FLAGS() [2/2]

UE::String::ENUM_CLASS_FLAGS ( EParseTokensOptions  )

◆ Escape()

Private::FEscape UE::String::Escape ( FStringView  Input)
inline

Escape the string when appended to a string builder.

Example: Builder << String::Escape(Value);

◆ EscapeTo()

CORE_API void UE::String::EscapeTo ( FStringView  Input,
FStringBuilderBase Output 
)

Escape the string into the string builder.

Example: Escape("Tab is \t and \" is a quote.", Output) -> "Tab is \\t and \\\" is a quote."

◆ FindFirst() [1/2]

CORE_API int32 UE::String::FindFirst ( FUtf8StringView  View,
FUtf8StringView  Search,
ESearchCase::Type  SearchCase = ESearchCase::CaseSensitive 
)

Search the view for the first occurrence of the search string.

Parameters
ViewThe string to search within.
SearchThe string to search for.
SearchCaseWhether the comparison should ignore case.
Returns
The position at which the search string was found, or INDEX_NONE if not found.

◆ FindFirst() [2/2]

CORE_API int32 UE::String::FindFirst ( FWideStringView  View,
FWideStringView  Search,
ESearchCase::Type  SearchCase 
)

◆ FindFirstChar() [1/2]

CORE_API int32 UE::String::FindFirstChar ( FUtf8StringView  View,
UTF8CHAR  Search,
ESearchCase::Type  SearchCase = ESearchCase::CaseSensitive 
)

Search the view for the first occurrence of the search character.

Parameters
ViewThe string to search within.
SearchThe character to search for.
SearchCaseWhether the comparison should ignore case.
Returns
The position at which the search character was found, or INDEX_NONE if not found.

◆ FindFirstChar() [2/2]

CORE_API int32 UE::String::FindFirstChar ( FWideStringView  View,
WIDECHAR  Search,
ESearchCase::Type  SearchCase 
)

◆ FindFirstOfAny() [1/3]

CORE_API int32 UE::String::FindFirstOfAny ( FAnsiStringView  View,
TConstArrayView< FAnsiStringView Search,
ESearchCase::Type  SearchCase = ESearchCase::CaseSensitive,
int32 OutMatchIndex = nullptr 
)

Search the view for the first occurrence of any search string.

Parameters
ViewThe string to search within.
SearchThe strings to search for.
SearchCaseWhether the comparison should ignore case.
OutMatchIndexReceives the index of the search string that matched.
Returns
The position at which any search string was found, or INDEX_NONE if not found.

◆ FindFirstOfAny() [2/3]

CORE_API int32 UE::String::FindFirstOfAny ( FUtf8StringView  View,
TConstArrayView< FUtf8StringView Search,
ESearchCase::Type  SearchCase,
int32 OutMatchIndex 
)

◆ FindFirstOfAny() [3/3]

CORE_API int32 UE::String::FindFirstOfAny ( FWideStringView  View,
TConstArrayView< FWideStringView Search,
ESearchCase::Type  SearchCase,
int32 OutMatchIndex 
)

◆ FindFirstOfAnyChar() [1/4]

CORE_API int32 UE::String::FindFirstOfAnyChar ( FUtf8StringView  View,
std::initializer_list< UTF8CHAR Search,
ESearchCase::Type  SearchCase = ESearchCase::CaseSensitive,
int32 OutMatchIndex = nullptr 
)

Search the view for the first occurrence of any search character.

Parameters
ViewThe string to search within.
SearchThe characters to search for.
SearchCaseWhether the comparison should ignore case.
OutMatchIndexReceives the index of the search character that matched.
Returns
The position at which any search character was found, or INDEX_NONE if not found.

◆ FindFirstOfAnyChar() [2/4]

CORE_API int32 UE::String::FindFirstOfAnyChar ( FUtf8StringView  View,
TConstArrayView< ANSICHAR Search,
ESearchCase::Type  SearchCase,
int32 OutMatchIndex 
)

◆ FindFirstOfAnyChar() [3/4]

CORE_API int32 UE::String::FindFirstOfAnyChar ( FUtf8StringView  View,
TConstArrayView< UTF8CHAR Search,
ESearchCase::Type  SearchCase,
int32 OutMatchIndex 
)

◆ FindFirstOfAnyChar() [4/4]

CORE_API int32 UE::String::FindFirstOfAnyChar ( FWideStringView  View,
TConstArrayView< WIDECHAR Search,
ESearchCase::Type  SearchCase,
int32 OutMatchIndex 
)

◆ FindLast() [1/2]

CORE_API int32 UE::String::FindLast ( FUtf8StringView  View,
FUtf8StringView  Search,
ESearchCase::Type  SearchCase = ESearchCase::CaseSensitive 
)

Search the view for the last occurrence of the search string.

Parameters
ViewThe string to search within.
SearchThe string to search for.
SearchCaseWhether the comparison should ignore case.
Returns
The position at which the search string was found, or INDEX_NONE if not found.

◆ FindLast() [2/2]

CORE_API int32 UE::String::FindLast ( FWideStringView  View,
FWideStringView  Search,
ESearchCase::Type  SearchCase 
)

◆ FindLastChar() [1/2]

CORE_API int32 UE::String::FindLastChar ( FUtf8StringView  View,
UTF8CHAR  Search,
ESearchCase::Type  SearchCase = ESearchCase::CaseSensitive 
)

Search the view for the last occurrence of the search character.

Parameters
ViewThe string to search within.
SearchThe character to search for.
SearchCaseWhether the comparison should ignore case.
Returns
The position at which the search character was found, or INDEX_NONE if not found.

◆ FindLastChar() [2/2]

CORE_API int32 UE::String::FindLastChar ( FWideStringView  View,
WIDECHAR  Search,
ESearchCase::Type  SearchCase 
)

◆ FindLastOfAny() [1/3]

CORE_API int32 UE::String::FindLastOfAny ( FAnsiStringView  View,
TConstArrayView< FAnsiStringView Search,
ESearchCase::Type  SearchCase = ESearchCase::CaseSensitive,
int32 OutMatchIndex = nullptr 
)

Search the view for the last occurrence of any search string.

Parameters
ViewThe string to search within.
SearchThe strings to search for.
SearchCaseWhether the comparison should ignore case.
OutMatchIndexReceives the index of the search string that matched.
Returns
The position at which any search string was found, or INDEX_NONE if not found.

◆ FindLastOfAny() [2/3]

CORE_API int32 UE::String::FindLastOfAny ( FUtf8StringView  View,
TConstArrayView< FUtf8StringView Search,
ESearchCase::Type  SearchCase,
int32 OutMatchIndex 
)

◆ FindLastOfAny() [3/3]

CORE_API int32 UE::String::FindLastOfAny ( FWideStringView  View,
TConstArrayView< FWideStringView Search,
ESearchCase::Type  SearchCase,
int32 OutMatchIndex 
)

◆ FindLastOfAnyChar() [1/4]

CORE_API int32 UE::String::FindLastOfAnyChar ( FUtf8StringView  View,
std::initializer_list< UTF8CHAR Search,
ESearchCase::Type  SearchCase = ESearchCase::CaseSensitive,
int32 OutMatchIndex = nullptr 
)

Search the view for the last occurrence of any search character.

Parameters
ViewThe string to search within.
SearchThe characters to search for.
SearchCaseWhether the comparison should ignore case.
OutMatchIndexReceives the index of the search character that matched.
Returns
The position at which any search character was found, or INDEX_NONE if not found.

◆ FindLastOfAnyChar() [2/4]

CORE_API int32 UE::String::FindLastOfAnyChar ( FUtf8StringView  View,
TConstArrayView< ANSICHAR Search,
ESearchCase::Type  SearchCase,
int32 OutMatchIndex 
)

◆ FindLastOfAnyChar() [3/4]

CORE_API int32 UE::String::FindLastOfAnyChar ( FUtf8StringView  View,
TConstArrayView< UTF8CHAR Search,
ESearchCase::Type  SearchCase,
int32 OutMatchIndex 
)

◆ FindLastOfAnyChar() [4/4]

CORE_API int32 UE::String::FindLastOfAnyChar ( FWideStringView  View,
TConstArrayView< WIDECHAR Search,
ESearchCase::Type  SearchCase,
int32 OutMatchIndex 
)

◆ FromHostLineEndings() [1/2]

CORE_API FString UE::String::FromHostLineEndings ( const FString &  InString)

Replaces all Line Endings with "\n" line terminator

◆ FromHostLineEndings() [2/2]

CORE_API FString UE::String::FromHostLineEndings ( FString &&  InString)

◆ FromHostLineEndingsInline()

CORE_API void UE::String::FromHostLineEndingsInline ( FString &  InString)

◆ HexToBytes() [1/2]

CORE_API int32 UE::String::HexToBytes ( FUtf8StringView  Hex,
uint8 OutBytes 
)

◆ HexToBytes() [2/2]

CORE_API int32 UE::String::HexToBytes ( FWideStringView  Hex,
uint8 OutBytes 
)

Convert an array of hex digits into an array of bytes.

Parameters
HexArray of hex digits to convert.
OutBytes[out] Array of at least (Hex.Len()+1)/2 output bytes.
Returns
Number of bytes written to the output.

◆ IsNumeric() [1/2]

CORE_API bool UE::String::IsNumeric ( FUtf8StringView  View)

◆ IsNumeric() [2/2]

CORE_API bool UE::String::IsNumeric ( FWideStringView  View)

Checks if the passed in string contains only digits, at most one dot, and optionally a +/- sign at the start.

Parameters
ViewThe string to check.
Returns
True if the string looks like a valid floating point number.

◆ IsNumericOnlyDigits() [1/2]

CORE_API bool UE::String::IsNumericOnlyDigits ( FUtf8StringView  View)

◆ IsNumericOnlyDigits() [2/2]

CORE_API bool UE::String::IsNumericOnlyDigits ( FWideStringView  View)

Checks if the passed in string contains only digits.

Parameters
ViewThe string to check.
Returns
True if the string only contains numeric characters.

◆ Join()

template<typename RangeType , typename DelimiterType >
auto UE::String::Join ( RangeType &&  Range,
DelimiterType &&  Delimiter 
) -> Private::TJoinBy<RangeType, FIdentityFunctor, DelimiterType>
inline

Create an object that can be appended to a string builder to append every element of the range to the builder, separating the elements by the delimiter.

Parameters
RangeThe range of elements to join and append.
DelimiterThe delimiter to append as a separator for the elements.
Returns
An anonymous object to append to a string builder.

◆ JoinBy()

auto UE::String::JoinBy ( RangeType &&  Range,
ProjectionType  Projection,
DelimiterType &&  Delimiter 
) -> Private::TJoinBy<RangeType, ProjectionType, DelimiterType>
inline

Create an object that can be appended to a string builder to append every element of the range to the builder, separating the elements by the delimiter.

Parameters
RangeThe range of elements to join and append.
ProjectionThe projection to apply to the elements before appending them.
DelimiterThe delimiter to append as a separator for the elements.
Returns
An anonymous object to append to a string builder.

◆ JoinByTo()

template<typename RangeType , typename ProjectionType , typename DelimiterType , typename CharType >
TStringBuilderBase< CharType > & UE::String::JoinByTo ( RangeType &&  Range,
ProjectionType  Projection,
DelimiterType &&  Delimiter,
TStringBuilderBase< CharType > &  Builder 
)
inline

Append every element of the range to the builder, separating the elements by the delimiter.

Parameters
RangeThe range of elements to join and append.
ProjectionThe projection to apply to the elements before appending them.
DelimiterThe delimiter to append as a separator for the elements.
BuilderThe builder to append to.
Returns
The builder, to allow additional operations to be composed with this one.

◆ JoinQuoted()

template<typename RangeType , typename DelimiterType , typename QuoteType >
auto UE::String::JoinQuoted ( RangeType &&  Range,
DelimiterType &&  Delimiter,
QuoteType &&  Quote 
) -> Private::TJoinQuotedBy<RangeType, FIdentityFunctor, DelimiterType, QuoteType>
inline

Create an object that can be appended to a string builder to append every element of the range to the builder, separating the elements by the delimiter and surrounding every element on both sides with a quote.

Parameters
RangeThe range of elements to join and append.
DelimiterThe delimiter to append as a separator for the elements.
QuoteThe quote to append on both sides of each element.
Returns
An anonymous object to append to a string builder.

◆ JoinQuotedBy()

auto UE::String::JoinQuotedBy ( RangeType &&  Range,
ProjectionType  Projection,
DelimiterType &&  Delimiter,
QuoteType &&  Quote 
) -> Private::TJoinQuotedBy<RangeType, ProjectionType, DelimiterType, QuoteType>
inline

Create an object that can be appended to a string builder to append every element of the range to the builder, separating the elements by the delimiter and surrounding every element on both sides with a quote.

Parameters
RangeThe range of elements to join and append.
ProjectionThe projection to apply to the elements before appending them.
DelimiterThe delimiter to append as a separator for the elements.
QuoteThe quote to append on both sides of each element.
Returns
An anonymous object to append to a string builder.

◆ JoinQuotedByTo()

TStringBuilderBase< CharType > & UE::String::JoinQuotedByTo ( RangeType &&  Range,
ProjectionType  Projection,
DelimiterType &&  Delimiter,
QuoteType &&  Quote,
TStringBuilderBase< CharType > &  Builder 
)
inline

Append every element of the range to the builder, separating the elements by the delimiter, and surrounding every element on each side with the given quote.

Parameters
RangeThe range of elements to join and append.
ProjectionThe projection to apply to the elements before appending them.
DelimiterThe delimiter to append as a separator for the elements.
QuoteThe quote to append on both sides of each element.
BuilderThe builder to append to.
Returns
The builder, to allow additional operations to be composed with this one.

◆ JoinQuotedTo()

template<typename RangeType , typename DelimiterType , typename QuoteType , typename CharType >
TStringBuilderBase< CharType > & UE::String::JoinQuotedTo ( RangeType &&  Range,
DelimiterType &&  Delimiter,
QuoteType &&  Quote,
TStringBuilderBase< CharType > &  Builder 
)
inline

Append every element of the range to the builder, separating the elements by the delimiter, and surrounding every element on each side with the given quote.

Parameters
RangeThe range of elements to join and append.
DelimiterThe delimiter to append as a separator for the elements.
QuoteThe quote to append on both sides of each element.
BuilderThe builder to append to.
Returns
The builder, to allow additional operations to be composed with this one.

◆ JoinTo()

template<typename RangeType , typename DelimiterType , typename CharType >
TStringBuilderBase< CharType > & UE::String::JoinTo ( RangeType &&  Range,
DelimiterType &&  Delimiter,
TStringBuilderBase< CharType > &  Builder 
)
inline

Append every element of the range to the builder, separating the elements by the delimiter.

Parameters
RangeThe range of elements to join and append.
DelimiterThe delimiter to append as a separator for the elements.
BuilderThe builder to append to.
Returns
The builder, to allow additional operations to be composed with this one.

◆ JoinTuple()

auto UE::String::JoinTuple ( TupleType &&  Tuple,
DelimiterType &&  Delimiter 
) -> Private::TJoinTupleBy<TupleType, FIdentityFunctor, DelimiterType>
inline

Create an object that can be appended to a string builder to append every element of the tuple to the builder, separating the elements by the delimiter.

Parameters
TupleThe tuple of elements to join and append.
DelimiterThe delimiter to append as a separator for the elements.
Returns
An anonymous object to append to a string builder.

◆ JoinTupleBy()

auto UE::String::JoinTupleBy ( TupleType &&  Tuple,
ProjectionType  Projection,
DelimiterType &&  Delimiter 
) -> Private::TJoinTupleBy<TupleType, ProjectionType, DelimiterType>
inline

Create an object that can be appended to a string builder to append every element of the tuple to the builder, separating the elements by the delimiter.

Parameters
TupleThe tuple of elements to join and append.
ProjectionThe projection to apply to the elements before appending them.
DelimiterThe delimiter to append as a separator for the elements.
Returns
An anonymous object to append to a string builder.

◆ JoinTupleByTo()

TStringBuilderBase< CharType > & UE::String::JoinTupleByTo ( TupleType &&  Tuple,
ProjectionType  Projection,
DelimiterType &&  Delimiter,
TStringBuilderBase< CharType > &  Builder 
)
inline

Append every element of the tuple to the builder, separating the elements by the delimiter.

Parameters
TupleThe tuple of elements to join and append.
ProjectionThe projection to apply to the elements before appending them.
DelimiterThe delimiter to append as a separator for the elements.
BuilderThe builder to append to.
Returns
The builder, to allow additional operations to be composed with this one.

◆ JoinTupleQuoted()

auto UE::String::JoinTupleQuoted ( TupleType &&  Tuple,
DelimiterType &&  Delimiter,
QuoteType &&  Quote 
) -> Private::TJoinTupleQuotedBy<TupleType, FIdentityFunctor, DelimiterType, QuoteType>
inline

Create an object that can be appended to a string builder to append every element of the tuple to the builder, separating the elements by the delimiter and surrounding every element on both sides with a quote.

Parameters
TupleThe tuple of elements to join and append.
DelimiterThe delimiter to append as a separator for the elements.
QuoteThe quote to append on both sides of each element.
Returns
An anonymous object to append to a string builder.

◆ JoinTupleQuotedBy()

auto UE::String::JoinTupleQuotedBy ( TupleType &&  Tuple,
ProjectionType  Projection,
DelimiterType &&  Delimiter,
QuoteType &&  Quote 
) -> Private::TJoinTupleQuotedBy<TupleType, ProjectionType, DelimiterType, QuoteType>
inline

Create an object that can be appended to a string builder to append every element of the tuple to the builder, separating the elements by the delimiter and surrounding every element on both sides with a quote.

Parameters
TupleThe tuple of elements to join and append.
ProjectionThe projection to apply to the elements before appending them.
DelimiterThe delimiter to append as a separator for the elements.
QuoteThe quote to append on both sides of each element.
Returns
An anonymous object to append to a string builder.

◆ JoinTupleQuotedByTo()

TStringBuilderBase< CharType > & UE::String::JoinTupleQuotedByTo ( TupleType &&  Tuple,
ProjectionType  Projection,
DelimiterType &&  Delimiter,
QuoteType &&  Quote,
TStringBuilderBase< CharType > &  Builder 
)
inline

Append every element of the tuple to the builder, separating the elements by the delimiter, and surrounding every element on each side with the given quote.

Parameters
TupleThe tuple of elements to join and append.
ProjectionThe projection to apply to the elements before appending them.
DelimiterThe delimiter to append as a separator for the elements.
QuoteThe quote to append on both sides of each element.
BuilderThe builder to append to.
Returns
The builder, to allow additional operations to be composed with this one.

◆ JoinTupleQuotedTo()

TStringBuilderBase< CharType > & UE::String::JoinTupleQuotedTo ( TupleType &&  Tuple,
DelimiterType &&  Delimiter,
QuoteType &&  Quote,
TStringBuilderBase< CharType > &  Builder 
)
inline

Append every element of the tuple to the builder, separating the elements by the delimiter, and surrounding every element on each side with the given quote.

Parameters
TupleThe tuple of elements to join and append.
DelimiterThe delimiter to append as a separator for the elements.
QuoteThe quote to append on both sides of each element.
BuilderThe builder to append to.
Returns
The builder, to allow additional operations to be composed with this one.

◆ JoinTupleTo()

TStringBuilderBase< CharType > & UE::String::JoinTupleTo ( TupleType &&  Tuple,
DelimiterType &&  Delimiter,
TStringBuilderBase< CharType > &  Builder 
)
inline

Append every element of the tuple to the builder, separating the elements by the delimiter.

Parameters
TupleThe tuple of elements to join and append.
DelimiterThe delimiter to append as a separator for the elements.
BuilderThe builder to append to.
Returns
The builder, to allow additional operations to be composed with this one.

◆ LowerCase() [1/3]

Private::TLowerCase< ANSICHAR > UE::String::LowerCase ( FAnsiStringView  Input)
inline

Convert the string to lowercase when appended to a string builder.

Note
Only ASCII characters will be converted, similar to CRT to[w]upper() with the standard C locale.
Parameters
InputThe string to convert to lowercase.
Returns
An anonymous object to append to a string builder.
Builder << String::LowerCase(TEXTVIEW("EXAMPLE")); // Builder now contains "example"
#define TEXTVIEW(str)
Definition StringView.h:553
Private::TLowerCase< ANSICHAR > LowerCase(FAnsiStringView Input)
Definition CaseConversion.h:105

◆ LowerCase() [2/3]

Private::TLowerCase< UTF8CHAR > UE::String::LowerCase ( FUtf8StringView  Input)
inline

◆ LowerCase() [3/3]

Private::TLowerCase< WIDECHAR > UE::String::LowerCase ( FWideStringView  Input)
inline

◆ LowerCaseTo() [1/3]

CORE_API void UE::String::LowerCaseTo ( FAnsiStringView  Input,
FAnsiStringBuilderBase Output 
)

Convert the string to lowercase and append to the string builder.

Note
Only ASCII characters will be converted, similar to CRT to[w]upper() with the standard C locale.
Parameters
InputThe string to convert to lowercase.
OutputThe string builder to append the converted string to.
LowerCaseTo(TEXTVIEW("EXAMPLE"), Output); // Output now contains "example"
void LowerCaseTo(FAnsiStringView Input, FAnsiStringBuilderBase &Output)
Definition CaseConversion.cpp:119

◆ LowerCaseTo() [2/3]

CORE_API void UE::String::LowerCaseTo ( FUtf8StringView  Input,
FUtf8StringBuilderBase Output 
)

◆ LowerCaseTo() [3/3]

CORE_API void UE::String::LowerCaseTo ( FWideStringView  Input,
FWideStringBuilderBase Output 
)

◆ ParseLines() [1/3]

template<typename OutputType , typename StringViewType >
void UE::String::ParseLines ( const StringViewType  View,
OutputType &  Output,
const EParseLinesOptions  Options = EParseLinesOptions::None 
)
inline

Parse lines in the input string as terminated by any of CRLF, CR, LF.

Output strings are sub-views of the input view and have the same lifetime as the input view. By default, empty lines are collected.

Parameters
ViewA view of the string to split into lines.
OutputThe output to add parsed lines to by calling Output.Add(FStringView).
OptionsFlags to modify the default behavior.

◆ ParseLines() [2/3]

CORE_API void UE::String::ParseLines ( FUtf8StringView  View,
TFunctionRef< void(FUtf8StringView)>  Visitor,
EParseLinesOptions  Options 
)

◆ ParseLines() [3/3]

CORE_API void UE::String::ParseLines ( FWideStringView  View,
TFunctionRef< void(FWideStringView)>  Visitor,
EParseLinesOptions  Options = EParseLinesOptions::None 
)

Visit every line in the input string as terminated by any of CRLF, CR, LF.

By default, empty lines are visited.

Parameters
ViewA view of the string to split into lines.
VisitorA function that is called for each line.
OptionsFlags to modify the default behavior.

◆ ParseTokens() [1/12]

template<typename OutputType >
void UE::String::ParseTokens ( const FAnsiStringView  View,
const ANSICHAR  Delimiter,
OutputType &  Output,
const EParseTokensOptions  Options = EParseTokensOptions::None 
)
inline

Parses every token in the input string, as separated by the delimiter.

Output strings are sub-views of the input view and have the same lifetime as the input view. By default, comparisons with the delimiter are case-sensitive and empty tokens are visited.

Parameters
ViewA view of the string to split into tokens.
DelimiterA delimiter character to split on.
OutputThe output to add parsed tokens to by calling Output.Add(FStringView).
OptionsFlags to modify the default behavior.

◆ ParseTokens() [2/12]

CORE_API void UE::String::ParseTokens ( FAnsiStringView  View,
ANSICHAR  Delimiter,
TFunctionRef< void(FAnsiStringView)>  Visitor,
EParseTokensOptions  Options = EParseTokensOptions::None 
)

Visit every token in the input string, as separated by the delimiter.

By default, comparisons with the delimiter are case-sensitive and empty tokens are visited.

Parameters
ViewA view of the string to split into tokens.
DelimiterA delimiter character to split on.
VisitorA function that is called for each token.
OptionsFlags to modify the default behavior.

◆ ParseTokens() [3/12]

template<typename OutputType >
void UE::String::ParseTokens ( const FAnsiStringView  View,
const FAnsiStringView  Delimiter,
OutputType &  Output,
const EParseTokensOptions  Options = EParseTokensOptions::None 
)
inline

Parses every token in the input string, as separated by the delimiter.

Output strings are sub-views of the input view and have the same lifetime as the input view. By default, comparisons with the delimiter are case-sensitive and empty tokens are visited.

Parameters
ViewA view of the string to split into tokens.
DelimiterA non-empty delimiter to split on.
OutputThe output to add parsed tokens to by calling Output.Add(FStringView).
OptionsFlags to modify the default behavior.

◆ ParseTokens() [4/12]

CORE_API void UE::String::ParseTokens ( FAnsiStringView  View,
FAnsiStringView  Delimiter,
TFunctionRef< void(FAnsiStringView)>  Visitor,
EParseTokensOptions  Options = EParseTokensOptions::None 
)

Visit every token in the input string, as separated by the delimiter.

By default, comparisons with the delimiter are case-sensitive and empty tokens are visited.

Parameters
ViewA view of the string to split into tokens.
DelimiterA non-empty delimiter to split on.
VisitorA function that is called for each token.
OptionsFlags to modify the default behavior.

◆ ParseTokens() [5/12]

template<typename OutputType >
void UE::String::ParseTokens ( const FUtf8StringView  View,
const FUtf8StringView  Delimiter,
OutputType &  Output,
const EParseTokensOptions  Options = EParseTokensOptions::None 
)
inline

◆ ParseTokens() [6/12]

CORE_API void UE::String::ParseTokens ( const FUtf8StringView  View,
const FUtf8StringView  Delimiter,
TFunctionRef< void(FUtf8StringView)>  Visitor,
const EParseTokensOptions  Options 
)

◆ ParseTokens() [7/12]

template<typename OutputType >
void UE::String::ParseTokens ( const FUtf8StringView  View,
const UTF8CHAR  Delimiter,
OutputType &  Output,
const EParseTokensOptions  Options = EParseTokensOptions::None 
)
inline

◆ ParseTokens() [8/12]

CORE_API void UE::String::ParseTokens ( const FUtf8StringView  View,
const UTF8CHAR  Delimiter,
TFunctionRef< void(FUtf8StringView)>  Visitor,
const EParseTokensOptions  Options 
)

◆ ParseTokens() [9/12]

template<typename OutputType >
void UE::String::ParseTokens ( const FWideStringView  View,
const FWideStringView  Delimiter,
OutputType &  Output,
const EParseTokensOptions  Options = EParseTokensOptions::None 
)
inline

◆ ParseTokens() [10/12]

CORE_API void UE::String::ParseTokens ( const FWideStringView  View,
const FWideStringView  Delimiter,
TFunctionRef< void(FWideStringView)>  Visitor,
const EParseTokensOptions  Options 
)

◆ ParseTokens() [11/12]

template<typename OutputType >
void UE::String::ParseTokens ( const FWideStringView  View,
const WIDECHAR  Delimiter,
OutputType &  Output,
const EParseTokensOptions  Options = EParseTokensOptions::None 
)
inline

◆ ParseTokens() [12/12]

CORE_API void UE::String::ParseTokens ( const FWideStringView  View,
const WIDECHAR  Delimiter,
TFunctionRef< void(FWideStringView)>  Visitor,
const EParseTokensOptions  Options 
)

◆ ParseTokensMultiple() [1/12]

template<typename OutputType >
void UE::String::ParseTokensMultiple ( const FAnsiStringView  View,
const TConstArrayView< ANSICHAR Delimiters,
OutputType &  Output,
const EParseTokensOptions  Options = EParseTokensOptions::None 
)
inline

Parses every token in the input string, as separated by any of the delimiters.

Output strings are sub-views of the input view and have the same lifetime as the input view. By default, comparisons with delimiters are case-sensitive and empty tokens are visited.

Parameters
ViewA view of the string to split into tokens.
DelimitersAn array of delimiter characters to split on.
OutputThe output to add parsed tokens to by calling Output.Add(FStringView).
OptionsFlags to modify the default behavior.

◆ ParseTokensMultiple() [2/12]

CORE_API void UE::String::ParseTokensMultiple ( FAnsiStringView  View,
TConstArrayView< ANSICHAR Delimiters,
TFunctionRef< void(FAnsiStringView)>  Visitor,
EParseTokensOptions  Options = EParseTokensOptions::None 
)

Visit every token in the input string, as separated by any of the delimiters.

By default, comparisons with delimiters are case-sensitive and empty tokens are visited.

Parameters
ViewA view of the string to split into tokens.
DelimitersAn array of delimiter characters to split on.
VisitorA function that is called for each token.
OptionsFlags to modify the default behavior.

◆ ParseTokensMultiple() [3/12]

template<typename OutputType >
void UE::String::ParseTokensMultiple ( const FAnsiStringView  View,
const TConstArrayView< FAnsiStringView Delimiters,
OutputType &  Output,
const EParseTokensOptions  Options = EParseTokensOptions::None 
)
inline

Parses every token in the input string, as separated by any of the delimiters.

Output strings are sub-views of the input view and have the same lifetime as the input view. By default, comparisons with delimiters are case-sensitive and empty tokens are visited. Behavior is undefined when delimiters overlap each other, such as the delimiters ("AB, "BC") and the input string "1ABC2".

Parameters
ViewA view of the string to split into tokens.
DelimitersAn array of non-overlapping non-empty delimiters to split on.
OutputThe output to add parsed tokens to by calling Output.Add(FStringView).
OptionsFlags to modify the default behavior.

◆ ParseTokensMultiple() [4/12]

CORE_API void UE::String::ParseTokensMultiple ( FAnsiStringView  View,
TConstArrayView< FAnsiStringView Delimiters,
TFunctionRef< void(FAnsiStringView)>  Visitor,
EParseTokensOptions  Options = EParseTokensOptions::None 
)

Visit every token in the input string, as separated by any of the delimiters.

By default, comparisons with delimiters are case-sensitive and empty tokens are visited. Behavior is undefined when delimiters overlap each other, such as the delimiters ("AB, "BC") and the input string "1ABC2".

Parameters
ViewA view of the string to split into tokens.
DelimitersAn array of non-overlapping non-empty delimiters to split on.
VisitorA function that is called for each token.
OptionsFlags to modify the default behavior.

◆ ParseTokensMultiple() [5/12]

template<typename OutputType >
void UE::String::ParseTokensMultiple ( const FUtf8StringView  View,
const TConstArrayView< FUtf8StringView Delimiters,
OutputType &  Output,
const EParseTokensOptions  Options = EParseTokensOptions::None 
)
inline

◆ ParseTokensMultiple() [6/12]

CORE_API void UE::String::ParseTokensMultiple ( const FUtf8StringView  View,
const TConstArrayView< FUtf8StringView Delimiters,
TFunctionRef< void(FUtf8StringView)>  Visitor,
const EParseTokensOptions  Options 
)

◆ ParseTokensMultiple() [7/12]

template<typename OutputType >
void UE::String::ParseTokensMultiple ( const FUtf8StringView  View,
const TConstArrayView< UTF8CHAR Delimiters,
OutputType &  Output,
const EParseTokensOptions  Options = EParseTokensOptions::None 
)
inline

◆ ParseTokensMultiple() [8/12]

CORE_API void UE::String::ParseTokensMultiple ( const FUtf8StringView  View,
const TConstArrayView< UTF8CHAR Delimiters,
TFunctionRef< void(FUtf8StringView)>  Visitor,
const EParseTokensOptions  Options 
)

◆ ParseTokensMultiple() [9/12]

template<typename OutputType >
void UE::String::ParseTokensMultiple ( const FWideStringView  View,
const TConstArrayView< FWideStringView Delimiters,
OutputType &  Output,
const EParseTokensOptions  Options = EParseTokensOptions::None 
)
inline

◆ ParseTokensMultiple() [10/12]

CORE_API void UE::String::ParseTokensMultiple ( const FWideStringView  View,
const TConstArrayView< FWideStringView Delimiters,
TFunctionRef< void(FWideStringView)>  Visitor,
const EParseTokensOptions  Options 
)

◆ ParseTokensMultiple() [11/12]

template<typename OutputType >
void UE::String::ParseTokensMultiple ( const FWideStringView  View,
const TConstArrayView< WIDECHAR Delimiters,
OutputType &  Output,
const EParseTokensOptions  Options = EParseTokensOptions::None 
)
inline

◆ ParseTokensMultiple() [12/12]

CORE_API void UE::String::ParseTokensMultiple ( const FWideStringView  View,
const TConstArrayView< WIDECHAR Delimiters,
TFunctionRef< void(FWideStringView)>  Visitor,
const EParseTokensOptions  Options 
)

◆ PascalCase()

Private::TPascalCase< TCHAR > UE::String::PascalCase ( FStringView  Input)
inline

Convert the string to PascalCase when appended to a string builder.

Note
Only ASCII characters will be converted.
Parameters
InputThe string to convert to PascalCase.
Returns
An anonymous object to append to a string builder.
Builder << String::PascalCase(TEXTVIEW("EXAMPLE TEXT")); // Builder now contains "ExampleText"
Private::TPascalCase< TCHAR > PascalCase(FStringView Input)
Definition CaseConversion.h:129

◆ PascalCaseTo()

CORE_API void UE::String::PascalCaseTo ( FStringView  Input,
FStringBuilderBase Output 
)

Convert the string to PascalCase and append to the string builder.

Note
Only ASCII characters will be converted.
Parameters
InputThe string to convert to PascalCase.
OutputThe string builder to append the converted string to.
PascalCaseTo(TEXTVIEW("EXAMPLE TEXT"), Output); // Output now contains "ExampleText"
void PascalCaseTo(FStringView Input, FStringBuilderBase &Output)
Definition CaseConversion.cpp:134

◆ QuoteEscape()

Private::FQuoteEscape UE::String::QuoteEscape ( FStringView  Input)
inline

Quote and escape the string when appended to a string builder.

Example: Builder << String::QuoteEscape(Value);

◆ QuoteEscapeTo()

CORE_API void UE::String::QuoteEscapeTo ( FStringView  Input,
FStringBuilderBase Output 
)

Quote and escape the string into the string builder.

Example: QuoteEscape("Tab is \t and \" is a quote.", Output) -> "\"Tab is \\t and \\\" is a quote.\""

◆ RemoveFromEnd()

template<typename CharType >
TStringView< CharType > UE::String::RemoveFromEnd ( const TStringView< CharType >  View,
const TStringView< CharType >  Prefix,
ESearchCase::Type  SearchCase = ESearchCase::CaseSensitive 
)
inline

◆ RemoveFromStart()

template<typename CharType >
TStringView< CharType > UE::String::RemoveFromStart ( const TStringView< CharType >  View,
const TStringView< CharType >  Prefix,
ESearchCase::Type  SearchCase = ESearchCase::CaseSensitive 
)
inline

◆ SplitFirst() [1/3]

CORE_API bool UE::String::SplitFirst ( FAnsiStringView  View,
FAnsiStringView  Search,
FAnsiStringView OutLeft,
FAnsiStringView OutRight,
ESearchCase::Type  SearchCase = ESearchCase::CaseSensitive 
)

Split the view on the first occurrence of the search string.

Parameters
ViewThe string to split.
SearchThe string to search for and split on.
OutLeftReceives the part of the view to the left of the search string if it is found.
OutRightReceives the part of the view to the right of the search string if it is found.
SearchCaseWhether the comparison should ignore case.
Returns
true if the search string was found and the outputs were written, otherwise false.

◆ SplitFirst() [2/3]

CORE_API bool UE::String::SplitFirst ( FUtf8StringView  View,
FUtf8StringView  Search,
FUtf8StringView OutLeft,
FUtf8StringView OutRight,
ESearchCase::Type  SearchCase 
)

◆ SplitFirst() [3/3]

CORE_API bool UE::String::SplitFirst ( FWideStringView  View,
FWideStringView  Search,
FWideStringView OutLeft,
FWideStringView OutRight,
ESearchCase::Type  SearchCase 
)

◆ SplitFirstChar() [1/3]

CORE_API bool UE::String::SplitFirstChar ( FAnsiStringView  View,
ANSICHAR  Search,
FAnsiStringView OutLeft,
FAnsiStringView OutRight,
ESearchCase::Type  SearchCase = ESearchCase::CaseSensitive 
)

Split the view on the first occurrence of the search character.

Parameters
ViewThe string to split.
SearchThe character to search for and split on.
OutLeftReceives the part of the view to the left of the search character if it is found.
OutRightReceives the part of the view to the right of the search character if it is found.
SearchCaseWhether the comparison should ignore case.
Returns
true if the search character was found and the outputs were written, otherwise false.

◆ SplitFirstChar() [2/3]

CORE_API bool UE::String::SplitFirstChar ( FUtf8StringView  View,
UTF8CHAR  Search,
FUtf8StringView OutLeft,
FUtf8StringView OutRight,
ESearchCase::Type  SearchCase 
)

◆ SplitFirstChar() [3/3]

CORE_API bool UE::String::SplitFirstChar ( FWideStringView  View,
WIDECHAR  Search,
FWideStringView OutLeft,
FWideStringView OutRight,
ESearchCase::Type  SearchCase 
)

◆ SplitFirstOfAny() [1/3]

CORE_API bool UE::String::SplitFirstOfAny ( FAnsiStringView  View,
TConstArrayView< FAnsiStringView Search,
FAnsiStringView OutLeft,
FAnsiStringView OutRight,
ESearchCase::Type  SearchCase = ESearchCase::CaseSensitive,
int32 OutMatchIndex = nullptr 
)

Split the view on the first occurrence of any search string.

Parameters
ViewThe string to split.
SearchThe strings to search for and split on.
OutLeftReceives the part of the view to the left of the search string if it is found.
OutRightReceives the part of the view to the right of the search string if it is found.
SearchCaseWhether the comparison should ignore case.
OutMatchIndexReceives the index of the search string that matched.
Returns
true if the search string was found and the outputs were written, otherwise false.

◆ SplitFirstOfAny() [2/3]

CORE_API bool UE::String::SplitFirstOfAny ( FUtf8StringView  View,
TConstArrayView< FUtf8StringView Search,
FUtf8StringView OutLeft,
FUtf8StringView OutRight,
ESearchCase::Type  SearchCase,
int32 OutMatchIndex 
)

◆ SplitFirstOfAny() [3/3]

CORE_API bool UE::String::SplitFirstOfAny ( FWideStringView  View,
TConstArrayView< FWideStringView Search,
FWideStringView OutLeft,
FWideStringView OutRight,
ESearchCase::Type  SearchCase,
int32 OutMatchIndex 
)

◆ SplitFirstOfAnyChar() [1/3]

CORE_API bool UE::String::SplitFirstOfAnyChar ( FAnsiStringView  View,
TConstArrayView< ANSICHAR Search,
FAnsiStringView OutLeft,
FAnsiStringView OutRight,
ESearchCase::Type  SearchCase = ESearchCase::CaseSensitive,
int32 OutMatchIndex = nullptr 
)

Split the view on the first occurrence of any search character.

Parameters
ViewThe string to split.
SearchThe characters to search for and split on.
OutLeftReceives the part of the view to the left of the search character if it is found.
OutRightReceives the part of the view to the right of the search character if it is found.
SearchCaseWhether the comparison should ignore case.
OutMatchIndexReceives the index of the search character that matched.
Returns
true if the search character was found and the outputs were written, otherwise false.

◆ SplitFirstOfAnyChar() [2/3]

CORE_API bool UE::String::SplitFirstOfAnyChar ( FUtf8StringView  View,
TConstArrayView< UTF8CHAR Search,
FUtf8StringView OutLeft,
FUtf8StringView OutRight,
ESearchCase::Type  SearchCase,
int32 OutMatchIndex 
)

◆ SplitFirstOfAnyChar() [3/3]

CORE_API bool UE::String::SplitFirstOfAnyChar ( FWideStringView  View,
TConstArrayView< WIDECHAR Search,
FWideStringView OutLeft,
FWideStringView OutRight,
ESearchCase::Type  SearchCase,
int32 OutMatchIndex 
)

◆ SplitLast() [1/3]

CORE_API bool UE::String::SplitLast ( FAnsiStringView  View,
FAnsiStringView  Search,
FAnsiStringView OutLeft,
FAnsiStringView OutRight,
ESearchCase::Type  SearchCase = ESearchCase::CaseSensitive 
)

Split the view on the last occurrence of the search string.

Parameters
ViewThe string to split.
SearchThe string to search for and split on.
OutLeftReceives the part of the view to the left of the search string if it is found.
OutRightReceives the part of the view to the right of the search string if it is found.
SearchCaseWhether the comparison should ignore case.
Returns
true if the search string was found and the outputs were written, otherwise false.

◆ SplitLast() [2/3]

CORE_API bool UE::String::SplitLast ( FUtf8StringView  View,
FUtf8StringView  Search,
FUtf8StringView OutLeft,
FUtf8StringView OutRight,
ESearchCase::Type  SearchCase 
)

◆ SplitLast() [3/3]

CORE_API bool UE::String::SplitLast ( FWideStringView  View,
FWideStringView  Search,
FWideStringView OutLeft,
FWideStringView OutRight,
ESearchCase::Type  SearchCase 
)

◆ SplitLastChar() [1/3]

CORE_API bool UE::String::SplitLastChar ( FAnsiStringView  View,
ANSICHAR  Search,
FAnsiStringView OutLeft,
FAnsiStringView OutRight,
ESearchCase::Type  SearchCase = ESearchCase::CaseSensitive 
)

Split the view on the last occurrence of the search character.

Parameters
ViewThe string to split.
SearchThe character to search for and split on.
OutLeftReceives the part of the view to the left of the search character if it is found.
OutRightReceives the part of the view to the right of the search character if it is found.
SearchCaseWhether the comparison should ignore case.
Returns
true if the search character was found and the outputs were written, otherwise false.

◆ SplitLastChar() [2/3]

CORE_API bool UE::String::SplitLastChar ( FUtf8StringView  View,
UTF8CHAR  Search,
FUtf8StringView OutLeft,
FUtf8StringView OutRight,
ESearchCase::Type  SearchCase 
)

◆ SplitLastChar() [3/3]

CORE_API bool UE::String::SplitLastChar ( FWideStringView  View,
WIDECHAR  Search,
FWideStringView OutLeft,
FWideStringView OutRight,
ESearchCase::Type  SearchCase 
)

◆ SplitLastOfAny() [1/3]

CORE_API bool UE::String::SplitLastOfAny ( FAnsiStringView  View,
TConstArrayView< FAnsiStringView Search,
FAnsiStringView OutLeft,
FAnsiStringView OutRight,
ESearchCase::Type  SearchCase = ESearchCase::CaseSensitive,
int32 OutMatchIndex = nullptr 
)

Split the view on the last occurrence of any search string.

Parameters
ViewThe string to split.
SearchThe strings to search for and split on.
OutLeftReceives the part of the view to the left of the search string if it is found.
OutRightReceives the part of the view to the right of the search string if it is found.
SearchCaseWhether the comparison should ignore case.
OutMatchIndexReceives the index of the search string that matched.
Returns
true if the search string was found and the outputs were written, otherwise false.

◆ SplitLastOfAny() [2/3]

CORE_API bool UE::String::SplitLastOfAny ( FUtf8StringView  View,
TConstArrayView< FUtf8StringView Search,
FUtf8StringView OutLeft,
FUtf8StringView OutRight,
ESearchCase::Type  SearchCase,
int32 OutMatchIndex 
)

◆ SplitLastOfAny() [3/3]

CORE_API bool UE::String::SplitLastOfAny ( FWideStringView  View,
TConstArrayView< FWideStringView Search,
FWideStringView OutLeft,
FWideStringView OutRight,
ESearchCase::Type  SearchCase,
int32 OutMatchIndex 
)

◆ SplitLastOfAnyChar() [1/3]

CORE_API bool UE::String::SplitLastOfAnyChar ( FAnsiStringView  View,
TConstArrayView< ANSICHAR Search,
FAnsiStringView OutLeft,
FAnsiStringView OutRight,
ESearchCase::Type  SearchCase = ESearchCase::CaseSensitive,
int32 OutMatchIndex = nullptr 
)

Split the view on the last occurrence of any search character.

Parameters
ViewThe string to split.
SearchThe characters to search for and split on.
OutLeftReceives the part of the view to the left of the search character if it is found.
OutRightReceives the part of the view to the right of the search character if it is found.
SearchCaseWhether the comparison should ignore case.
OutMatchIndexReceives the index of the search character that matched.
Returns
true if the search character was found and the outputs were written, otherwise false.

◆ SplitLastOfAnyChar() [2/3]

CORE_API bool UE::String::SplitLastOfAnyChar ( FUtf8StringView  View,
TConstArrayView< UTF8CHAR Search,
FUtf8StringView OutLeft,
FUtf8StringView OutRight,
ESearchCase::Type  SearchCase,
int32 OutMatchIndex 
)

◆ SplitLastOfAnyChar() [3/3]

CORE_API bool UE::String::SplitLastOfAnyChar ( FWideStringView  View,
TConstArrayView< WIDECHAR Search,
FWideStringView OutLeft,
FWideStringView OutRight,
ESearchCase::Type  SearchCase,
int32 OutMatchIndex 
)

◆ ToHostLineEndings() [1/2]

CORE_API FString UE::String::ToHostLineEndings ( const FString &  InString)

Replaces all Line Endings with the host platform line terminator

◆ ToHostLineEndings() [2/2]

CORE_API FString UE::String::ToHostLineEndings ( FString &&  InString)

◆ ToHostLineEndingsInline()

CORE_API void UE::String::ToHostLineEndingsInline ( FString &  InString)

◆ UpperCase() [1/3]

Private::TUpperCase< ANSICHAR > UE::String::UpperCase ( FAnsiStringView  Input)
inline

Convert the string to uppercase when appended to a string builder.

Note
Only ASCII characters will be converted, similar to CRT to[w]upper() with the standard C locale.
Parameters
InputThe string to convert to uppercase.
Returns
An anonymous object to append to a string builder.
Builder << String::UpperCase(TEXTVIEW("example")); // Builder now contains "EXAMPLE"
Private::TUpperCase< ANSICHAR > UpperCase(FAnsiStringView Input)
Definition CaseConversion.h:81

◆ UpperCase() [2/3]

Private::TUpperCase< UTF8CHAR > UE::String::UpperCase ( FUtf8StringView  Input)
inline

◆ UpperCase() [3/3]

Private::TUpperCase< WIDECHAR > UE::String::UpperCase ( FWideStringView  Input)
inline

◆ UpperCaseTo() [1/3]

CORE_API void UE::String::UpperCaseTo ( FAnsiStringView  Input,
FAnsiStringBuilderBase Output 
)

Convert the string to uppercase and append to the string builder.

Note
Only ASCII characters will be converted, similar to CRT to[w]upper() with the standard C locale.
Parameters
InputThe string to convert to uppercase.
OutputThe string builder to append the converted string to.
UpperCaseTo(TEXTVIEW("example"), Output); // Output now contains "EXAMPLE"
void UpperCaseTo(FAnsiStringView Input, FAnsiStringBuilderBase &Output)
Definition CaseConversion.cpp:104

◆ UpperCaseTo() [2/3]

CORE_API void UE::String::UpperCaseTo ( FUtf8StringView  Input,
FUtf8StringBuilderBase Output 
)

◆ UpperCaseTo() [3/3]

CORE_API void UE::String::UpperCaseTo ( FWideStringView  Input,
FWideStringBuilderBase Output 
)