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
int32	FindFirst (FUtf8StringView View, FUtf8StringView Search, ESearchCase::Type SearchCase=ESearchCase::CaseSensitive)

int32	FindFirst (FWideStringView View, FWideStringView Search, ESearchCase::Type SearchCase=ESearchCase::CaseSensitive)

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

int32	FindLast (FWideStringView View, FWideStringView Search, ESearchCase::Type SearchCase=ESearchCase::CaseSensitive)

int32	FindFirstOfAny (FUtf8StringView View, TConstArrayView< FUtf8StringView > Search, ESearchCase::Type SearchCase=ESearchCase::CaseSensitive)

int32	FindFirstOfAny (FWideStringView View, TConstArrayView< FWideStringView > Search, ESearchCase::Type SearchCase=ESearchCase::CaseSensitive)

int32	FindLastOfAny (FUtf8StringView View, TConstArrayView< FUtf8StringView > Search, ESearchCase::Type SearchCase=ESearchCase::CaseSensitive)

int32	FindLastOfAny (FWideStringView View, TConstArrayView< FWideStringView > Search, ESearchCase::Type SearchCase=ESearchCase::CaseSensitive)

int32	FindFirstChar (FUtf8StringView View, ANSICHAR Search, ESearchCase::Type SearchCase=ESearchCase::CaseSensitive)

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

int32	FindFirstChar (FWideStringView View, WIDECHAR Search, ESearchCase::Type SearchCase=ESearchCase::CaseSensitive)

int32	FindLastChar (FUtf8StringView View, ANSICHAR Search, ESearchCase::Type SearchCase=ESearchCase::CaseSensitive)

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

int32	FindLastChar (FWideStringView View, WIDECHAR Search, ESearchCase::Type SearchCase=ESearchCase::CaseSensitive)

int32	FindFirstOfAnyChar (FUtf8StringView View, TConstArrayView< ANSICHAR > Search, ESearchCase::Type SearchCase=ESearchCase::CaseSensitive)

int32	FindFirstOfAnyChar (FUtf8StringView View, TConstArrayView< UTF8CHAR > Search, ESearchCase::Type SearchCase=ESearchCase::CaseSensitive)

int32	FindFirstOfAnyChar (FWideStringView View, TConstArrayView< WIDECHAR > Search, ESearchCase::Type SearchCase=ESearchCase::CaseSensitive)

int32	FindLastOfAnyChar (FUtf8StringView View, TConstArrayView< ANSICHAR > Search, ESearchCase::Type SearchCase=ESearchCase::CaseSensitive)

int32	FindLastOfAnyChar (FUtf8StringView View, TConstArrayView< UTF8CHAR > Search, ESearchCase::Type SearchCase=ESearchCase::CaseSensitive)

int32	FindLastOfAnyChar (FWideStringView View, TConstArrayView< WIDECHAR > Search, ESearchCase::Type SearchCase=ESearchCase::CaseSensitive)

int32	HexToBytes (FAnsiStringView Hex, uint8 *OutBytes)

int32	HexToBytes (FWideStringView Hex, uint8 *OutBytes)

int32	HexToBytes (FUtf8StringView Hex, uint8 *OutBytes)

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	EscapeTo (FStringView Input, FStringBuilderBase &Output)

Private::FEscape	Escape (FStringView Input)

void	QuoteEscapeTo (FStringView Input, FStringBuilderBase &Output)

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)

FString	FromHostLineEndings (const FString &InString)

FString	FromHostLineEndings (FString &&InString)

void	FromHostLineEndingsInline (FString &InString)

FString	ToHostLineEndings (const FString &InString)

FString	ToHostLineEndings (FString &&InString)

void	ToHostLineEndingsInline (FString &InString)

	ENUM_CLASS_FLAGS (EParseLinesOptions)

void	ParseLines (FStringView View, TFunctionRef< void(FStringView)> Visitor, EParseLinesOptions Options=EParseLinesOptions::None)

template<typename OutputType >
void	ParseLines (const FStringView View, OutputType &Output, const EParseLinesOptions Options=EParseLinesOptions::None)

	ENUM_CLASS_FLAGS (EParseTokensOptions)

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

void	ParseTokens (FWideStringView View, WIDECHAR Delimiter, TFunctionRef< void(FWideStringView)> Visitor, EParseTokensOptions Options=EParseTokensOptions::None)

void	ParseTokens (FUtf8StringView View, UTF8CHAR Delimiter, TFunctionRef< void(FUtf8StringView)> Visitor, EParseTokensOptions Options=EParseTokensOptions::None)

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)

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

void	ParseTokens (FWideStringView View, FWideStringView Delimiter, TFunctionRef< void(FWideStringView)> Visitor, EParseTokensOptions Options=EParseTokensOptions::None)

void	ParseTokens (FUtf8StringView View, FUtf8StringView Delimiter, TFunctionRef< void(FUtf8StringView)> Visitor, 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)

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

void	ParseTokensMultiple (FWideStringView View, TConstArrayView< WIDECHAR > Delimiters, TFunctionRef< void(FWideStringView)> Visitor, EParseTokensOptions Options=EParseTokensOptions::None)

void	ParseTokensMultiple (FUtf8StringView View, TConstArrayView< UTF8CHAR > Delimiters, TFunctionRef< void(FUtf8StringView)> Visitor, 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)

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

void	ParseTokensMultiple (FWideStringView View, TConstArrayView< FWideStringView > Delimiters, TFunctionRef< void(FWideStringView)> Visitor, EParseTokensOptions Options=EParseTokensOptions::None)

void	ParseTokensMultiple (FUtf8StringView View, TConstArrayView< FUtf8StringView > Delimiters, TFunctionRef< void(FUtf8StringView)> Visitor, 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 >
ARK_API TStringView< CharType >	RemoveFromStart (const TStringView< CharType > View, const TStringView< CharType > Prefix, ESearchCase::Type SearchCase=ESearchCase::CaseSensitive)

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

Enumeration Type Documentation

◆ EParseLinesOptions

enum class UE::String::EParseLinesOptions : uint32

strong

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.

Definition at line 16 of file ParseLines.h.

◆ EParseTokensOptions

enum class UE::String::EParseTokensOptions : uint32

strong

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.

Definition at line 18 of file ParseTokens.h.

Function Documentation

◆ BytesToHex() [1/6]

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

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

Parameters

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

◆ BytesToHex() [2/6]

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

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

Parameters

Bytes	Array of bytes to convert.
Builder	Builder to append the converted string to.

◆ BytesToHex() [3/6]

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

◆ BytesToHex() [4/6]

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

◆ BytesToHex() [5/6]

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

◆ BytesToHex() [6/6]

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

◆ BytesToHexLower() [1/6]

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

◆ BytesToHexLower() [2/6]

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

◆ BytesToHexLower() [3/6]

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

◆ BytesToHexLower() [4/6]

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

◆ BytesToHexLower() [5/6]

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

◆ BytesToHexLower() [6/6]

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);

Definition at line 32 of file Escape.h.

◆ EscapeTo()

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]

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

View	The string to search within.
Search	The string to search for.
SearchCase	Whether the comparison should ignore case.

Returns: The position at which the search string was found, or INDEX_NONE if not found.

◆ FindFirst() [2/2]

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

◆ FindFirstChar() [1/3]

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

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

Parameters

View	The string to search within.
Search	The character to search for.
SearchCase	Whether the comparison should ignore case.

Returns: The position at which the search character was found, or INDEX_NONE if not found.

◆ FindFirstChar() [2/3]

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

◆ FindFirstChar() [3/3]

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

◆ FindFirstOfAny() [1/2]

int32 UE::String::FindFirstOfAny	(	FUtf8StringView	View,
		TConstArrayView< FUtf8StringView >	Search,
		ESearchCase::Type	SearchCase = ESearchCase::CaseSensitive )

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

Parameters

View	The string to search within.
Search	The strings to search for.
SearchCase	Whether the comparison should ignore case.

Returns: The position at which any search string was found, or INDEX_NONE if not found.

◆ FindFirstOfAny() [2/2]

int32 UE::String::FindFirstOfAny	(	FWideStringView	View,
		TConstArrayView< FWideStringView >	Search,
		ESearchCase::Type	SearchCase = ESearchCase::CaseSensitive )

◆ FindFirstOfAnyChar() [1/3]

int32 UE::String::FindFirstOfAnyChar	(	FUtf8StringView	View,
		TConstArrayView< ANSICHAR >	Search,
		ESearchCase::Type	SearchCase = ESearchCase::CaseSensitive )

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

Parameters

View	The string to search within.
Search	The characters to search for.
SearchCase	Whether the comparison should ignore case.

Returns: The position at which any search character was found, or INDEX_NONE if not found.

◆ FindFirstOfAnyChar() [2/3]

int32 UE::String::FindFirstOfAnyChar	(	FUtf8StringView	View,
		TConstArrayView< UTF8CHAR >	Search,
		ESearchCase::Type	SearchCase = ESearchCase::CaseSensitive )

◆ FindFirstOfAnyChar() [3/3]

int32 UE::String::FindFirstOfAnyChar	(	FWideStringView	View,
		TConstArrayView< WIDECHAR >	Search,
		ESearchCase::Type	SearchCase = ESearchCase::CaseSensitive )

◆ FindLast() [1/2]

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

View	The string to search within.
Search	The string to search for.
SearchCase	Whether the comparison should ignore case.

Returns: The position at which the search string was found, or INDEX_NONE if not found.

◆ FindLast() [2/2]

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

◆ FindLastChar() [1/3]

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

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

Parameters

View	The string to search within.
Search	The character to search for.
SearchCase	Whether the comparison should ignore case.

Returns: The position at which the search character was found, or INDEX_NONE if not found.

◆ FindLastChar() [2/3]

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

◆ FindLastChar() [3/3]

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

◆ FindLastOfAny() [1/2]

int32 UE::String::FindLastOfAny	(	FUtf8StringView	View,
		TConstArrayView< FUtf8StringView >	Search,
		ESearchCase::Type	SearchCase = ESearchCase::CaseSensitive )

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

Parameters

View	The string to search within.
Search	The strings to search for.
SearchCase	Whether the comparison should ignore case.

Returns: The position at which any search string was found, or INDEX_NONE if not found.

◆ FindLastOfAny() [2/2]

int32 UE::String::FindLastOfAny	(	FWideStringView	View,
		TConstArrayView< FWideStringView >	Search,
		ESearchCase::Type	SearchCase = ESearchCase::CaseSensitive )

◆ FindLastOfAnyChar() [1/3]

int32 UE::String::FindLastOfAnyChar	(	FUtf8StringView	View,
		TConstArrayView< ANSICHAR >	Search,
		ESearchCase::Type	SearchCase = ESearchCase::CaseSensitive )

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

Parameters

View	The string to search within.
Search	The characters to search for.
SearchCase	Whether the comparison should ignore case.

Returns: The position at which any search character was found, or INDEX_NONE if not found.

◆ FindLastOfAnyChar() [2/3]

int32 UE::String::FindLastOfAnyChar	(	FUtf8StringView	View,
		TConstArrayView< UTF8CHAR >	Search,
		ESearchCase::Type	SearchCase = ESearchCase::CaseSensitive )

◆ FindLastOfAnyChar() [3/3]

int32 UE::String::FindLastOfAnyChar	(	FWideStringView	View,
		TConstArrayView< WIDECHAR >	Search,
		ESearchCase::Type	SearchCase = ESearchCase::CaseSensitive )

◆ FromHostLineEndings() [1/2]

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

Replaces all Line Endings with "\n" line terminator

◆ FromHostLineEndings() [2/2]

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

◆ FromHostLineEndingsInline()

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

◆ HexToBytes() [1/3]

int32 UE::String::HexToBytes	(	FAnsiStringView	Hex,
		uint8 *	OutBytes )

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

Parameters

Hex	Array 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.

◆ HexToBytes() [2/3]

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

◆ HexToBytes() [3/3]

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

◆ 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

Range	The range of elements to join and append.
Delimiter	The delimiter to append as a separator for the elements.

Returns: An anonymous object to append to a string builder.

Definition at line 190 of file Join.h.

◆ JoinBy()

template<typename RangeType , typename ProjectionType , typename DelimiterType >

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

Range	The range of elements to join and append.
Projection	The projection to apply to the elements before appending them.
Delimiter	The delimiter to append as a separator for the elements.

Returns: An anonymous object to append to a string builder.

Definition at line 141 of file Join.h.

◆ 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

Range	The range of elements to join and append.
Projection	The projection to apply to the elements before appending them.
Delimiter	The delimiter to append as a separator for the elements.
Builder	The builder to append to.

Returns: The builder, to allow additional operations to be composed with this one.

Definition at line 158 of file Join.h.

◆ 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

Range	The range of elements to join and append.
Delimiter	The delimiter to append as a separator for the elements.
Quote	The quote to append on both sides of each element.

Returns: An anonymous object to append to a string builder.

Definition at line 103 of file Join.h.

◆ JoinQuotedBy()

template<typename RangeType , typename ProjectionType , typename DelimiterType , typename QuoteType >

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

Range	The range of elements to join and append.
Projection	The projection to apply to the elements before appending them.
Delimiter	The delimiter to append as a separator for the elements.
Quote	The quote to append on both sides of each element.

Returns: An anonymous object to append to a string builder.

Definition at line 49 of file Join.h.

◆ JoinQuotedByTo()

template<typename RangeType , typename ProjectionType , typename DelimiterType , typename QuoteType , typename CharType >

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

Range	The range of elements to join and append.
Projection	The projection to apply to the elements before appending them.
Delimiter	The delimiter to append as a separator for the elements.
Quote	The quote to append on both sides of each element.
Builder	The builder to append to.

Returns: The builder, to allow additional operations to be composed with this one.

Definition at line 68 of file Join.h.

◆ 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

Range	The range of elements to join and append.
Delimiter	The delimiter to append as a separator for the elements.
Quote	The quote to append on both sides of each element.
Builder	The builder to append to.

Returns: The builder, to allow additional operations to be composed with this one.

Definition at line 121 of file Join.h.

◆ 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

Range	The range of elements to join and append.
Delimiter	The delimiter to append as a separator for the elements.
Builder	The builder to append to.

Returns: The builder, to allow additional operations to be composed with this one.

Definition at line 206 of file Join.h.

◆ ParseLines() [1/2]

template<typename OutputType >

void UE::String::ParseLines	(	const FStringView	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

View	A view of the string to split into lines.
Output	The output to add parsed lines to by calling Output.Add(FStringView).
Options	Flags to modify the default behavior.

Definition at line 53 of file ParseLines.h.

◆ ParseLines() [2/2]

void UE::String::ParseLines	(	FStringView	View,
		TFunctionRef< void(FStringView)>	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

View	A view of the string to split into lines.
Visitor	A function that is called for each line.
Options	Flags 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

View	A view of the string to split into tokens.
Delimiter	A delimiter character to split on.
Output	The output to add parsed tokens to by calling Output.Add(FStringView).
Options	Flags to modify the default behavior.

Definition at line 70 of file ParseTokens.h.

◆ ParseTokens() [2/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

View	A view of the string to split into tokens.
Delimiter	A non-empty delimiter to split on.
Output	The output to add parsed tokens to by calling Output.Add(FStringView).
Options	Flags to modify the default behavior.

Definition at line 135 of file ParseTokens.h.

◆ ParseTokens() [3/12]

template<typename OutputType >

void UE::String::ParseTokens	(	const FUtf8StringView	View,
		const FUtf8StringView	Delimiter,
		OutputType &	Output,
		const EParseTokensOptions	Options = EParseTokensOptions::None )

inline

Definition at line 153 of file ParseTokens.h.

◆ ParseTokens() [4/12]

template<typename OutputType >

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

inline

Definition at line 88 of file ParseTokens.h.

◆ ParseTokens() [5/12]

template<typename OutputType >

void UE::String::ParseTokens	(	const FWideStringView	View,
		const FWideStringView	Delimiter,
		OutputType &	Output,
		const EParseTokensOptions	Options = EParseTokensOptions::None )

inline

Definition at line 144 of file ParseTokens.h.

◆ ParseTokens() [6/12]

template<typename OutputType >

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

inline

Definition at line 79 of file ParseTokens.h.

◆ ParseTokens() [7/12]

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

View	A view of the string to split into tokens.
Delimiter	A delimiter character to split on.
Visitor	A function that is called for each token.
Options	Flags to modify the default behavior.

◆ ParseTokens() [8/12]

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

View	A view of the string to split into tokens.
Delimiter	A non-empty delimiter to split on.
Visitor	A function that is called for each token.
Options	Flags to modify the default behavior.

◆ ParseTokens() [9/12]

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

◆ ParseTokens() [10/12]

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

◆ ParseTokens() [11/12]

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

◆ ParseTokens() [12/12]

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

◆ 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

View	A view of the string to split into tokens.
Delimiters	An array of delimiter characters to split on.
Output	The output to add parsed tokens to by calling Output.Add(FStringView).
Options	Flags to modify the default behavior.

Definition at line 200 of file ParseTokens.h.

◆ ParseTokensMultiple() [2/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

View	A view of the string to split into tokens.
Delimiters	An array of non-overlapping non-empty delimiters to split on.
Output	The output to add parsed tokens to by calling Output.Add(FStringView).
Options	Flags to modify the default behavior.

Definition at line 269 of file ParseTokens.h.

◆ ParseTokensMultiple() [3/12]

template<typename OutputType >

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

inline

Definition at line 287 of file ParseTokens.h.

◆ ParseTokensMultiple() [4/12]

template<typename OutputType >

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

inline

Definition at line 218 of file ParseTokens.h.

◆ ParseTokensMultiple() [5/12]

template<typename OutputType >

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

inline

Definition at line 278 of file ParseTokens.h.

◆ ParseTokensMultiple() [6/12]

template<typename OutputType >

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

inline

Definition at line 209 of file ParseTokens.h.

◆ ParseTokensMultiple() [7/12]

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

View	A view of the string to split into tokens.
Delimiters	An array of delimiter characters to split on.
Visitor	A function that is called for each token.
Options	Flags to modify the default behavior.

◆ ParseTokensMultiple() [8/12]

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

View	A view of the string to split into tokens.
Delimiters	An array of non-overlapping non-empty delimiters to split on.
Visitor	A function that is called for each token.
Options	Flags to modify the default behavior.

◆ ParseTokensMultiple() [9/12]

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

◆ ParseTokensMultiple() [10/12]

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

◆ ParseTokensMultiple() [11/12]

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

◆ ParseTokensMultiple() [12/12]

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

◆ 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);

Definition at line 46 of file Escape.h.

◆ QuoteEscapeTo()

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 >

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

inline

Definition at line 18 of file RemoveFrom.h.

◆ RemoveFromStart()

template<typename CharType >

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

inline

Definition at line 12 of file RemoveFrom.h.

◆ ToHostLineEndings() [1/2]

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

Replaces all Line Endings with the host platform line terminator

◆ ToHostLineEndings() [2/2]

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

◆ ToHostLineEndingsInline()

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

Namespaces

Enumerations

Functions

Enumeration Type Documentation

◆ EParseLinesOptions

◆ EParseTokensOptions

Function Documentation

◆ BytesToHex() [1/6]

◆ BytesToHex() [2/6]

◆ BytesToHex() [3/6]

◆ BytesToHex() [4/6]

◆ BytesToHex() [5/6]

◆ BytesToHex() [6/6]

◆ BytesToHexLower() [1/6]

◆ BytesToHexLower() [2/6]

◆ BytesToHexLower() [3/6]

◆ BytesToHexLower() [4/6]

◆ BytesToHexLower() [5/6]

◆ BytesToHexLower() [6/6]

◆ ENUM_CLASS_FLAGS() [1/2]

◆ ENUM_CLASS_FLAGS() [2/2]

◆ Escape()

◆ EscapeTo()

◆ FindFirst() [1/2]

◆ FindFirst() [2/2]

◆ FindFirstChar() [1/3]

◆ FindFirstChar() [2/3]

◆ FindFirstChar() [3/3]

◆ FindFirstOfAny() [1/2]

◆ FindFirstOfAny() [2/2]

◆ FindFirstOfAnyChar() [1/3]

◆ FindFirstOfAnyChar() [2/3]

◆ FindFirstOfAnyChar() [3/3]

◆ FindLast() [1/2]

◆ FindLast() [2/2]

◆ FindLastChar() [1/3]

◆ FindLastChar() [2/3]

◆ FindLastChar() [3/3]

◆ FindLastOfAny() [1/2]

◆ FindLastOfAny() [2/2]

◆ FindLastOfAnyChar() [1/3]

◆ FindLastOfAnyChar() [2/3]

◆ FindLastOfAnyChar() [3/3]

◆ FromHostLineEndings() [1/2]

◆ FromHostLineEndings() [2/2]

◆ FromHostLineEndingsInline()

◆ HexToBytes() [1/3]

◆ HexToBytes() [2/3]

◆ HexToBytes() [3/3]

◆ Join()

◆ JoinBy()

◆ JoinByTo()

◆ JoinQuoted()

◆ JoinQuotedBy()

◆ JoinQuotedByTo()

◆ JoinQuotedTo()

◆ JoinTo()

◆ ParseLines() [1/2]

◆ ParseLines() [2/2]

◆ ParseTokens() [1/12]

◆ ParseTokens() [2/12]

◆ ParseTokens() [3/12]

◆ ParseTokens() [4/12]

◆ ParseTokens() [5/12]

◆ ParseTokens() [6/12]

◆ ParseTokens() [7/12]

◆ ParseTokens() [8/12]

◆ ParseTokens() [9/12]

◆ ParseTokens() [10/12]

◆ ParseTokens() [11/12]

◆ ParseTokens() [12/12]

◆ ParseTokensMultiple() [1/12]

◆ ParseTokensMultiple() [2/12]

◆ ParseTokensMultiple() [3/12]

◆ ParseTokensMultiple() [4/12]

◆ ParseTokensMultiple() [5/12]

◆ ParseTokensMultiple() [6/12]

◆ ParseTokensMultiple() [7/12]

◆ ParseTokensMultiple() [8/12]

◆ ParseTokensMultiple() [9/12]