UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | Public Attributes | Protected Member Functions | Friends | List of all members
uLang::CUTF8StringView Class Reference

#include <UTF8StringView.h>

Classes

class  UnicodeConstIterator
 

Public Member Functions

 CUTF8StringView ()
 
 CUTF8StringView (ENoInit)
 
 CUTF8StringView (const UTF8Char *Begin, const UTF8Char *End)
 
 CUTF8StringView (const char *NullterminatedString)
 
 CUTF8StringView (const char *String, size_t ByteLen)
 
void Reset ()
 
void Set (const UTF8Char *Begin, const UTF8Char *End)
 
ULANG_FORCEINLINE const UTF8Char * Data () const
 
ULANG_FORCEINLINE int32_t ByteLen () const
 
ULANG_FORCEINLINE bool IsEmpty () const
 
ULANG_FORCEINLINE bool IsFilled () const
 
ULANG_FORCEINLINE const UTF8Char & operator[] (int32_t ByteIndex) const
 
ULANG_FORCEINLINE UTF8Char FirstByte () const
 
ULANG_FORCEINLINE UTF8Char SecondByte () const
 
ULANG_FORCEINLINE UTF8Char LastByte () const
 
ULANG_FORCEINLINE UTF8Char NextByte (const CUTF8StringView &Enclosing) const
 
ULANG_FORCEINLINE UTF8Char NextNextByte (const CUTF8StringView &Enclosing) const
 
ULANG_FORCEINLINE SUniCodePointLength FirstCodePoint () const
 
ULANG_FORCEINLINE bool StartsWith (const CUTF8StringView &Text) const
 
ULANG_FORCEINLINE bool EndsWith (const CUTF8StringView &Text) const
 
ULANG_FORCEINLINE int32_t Find (UTF8Char Char) const
 
ULANG_FORCEINLINE int32_t Find (const CUTF8StringView &Text) const
 
ULANG_FORCEINLINE bool Contains (UTF8Char Char) const
 
ULANG_FORCEINLINE bool Contains (const CUTF8StringView &Text) const
 
ULANG_FORCEINLINE bool ContainsCaseIndependent (const CUTF8StringView &Text) const
 
bool operator== (const CUTF8StringView &Other) const
 
bool operator!= (const CUTF8StringView &Other) const
 
bool operator< (const CUTF8StringView &Other) const
 
bool operator> (const CUTF8StringView &Other) const
 
bool operator<= (const CUTF8StringView &Other) const
 
bool operator>= (const CUTF8StringView &Other) const
 
bool operator== (const char *NullTerminatedString) const
 
bool operator!= (const char *NullterminatedString) const
 
bool IsEqualCaseIndependent (const CUTF8StringView &Other) const
 
ULANG_FORCEINLINE UTF8Char PopFirstByte ()
 
ULANG_FORCEINLINE SUniCodePointLength PopFirstCodePoint ()
 
ULANG_FORCEINLINE CUTF8StringView SubViewBegin (int32_t ByteCount) const
 
ULANG_FORCEINLINE CUTF8StringView SubViewEnd (int32_t ByteCount) const
 
ULANG_FORCEINLINE CUTF8StringView SubViewTrimBegin (int32_t ByteIndex) const
 
ULANG_FORCEINLINE CUTF8StringView SubViewTrimEnd (int32_t ByteCount) const
 
ULANG_FORCEINLINE CUTF8StringView SubView (int32_t ByteIndex, int32_t ByteCount=INT32_MAX) const
 
ULANG_FORCEINLINE CUTF8StringView SubView (const SIdxRange &Range) const
 
ULANG_FORCEINLINE CUTF8StringView SubViewEmpty (int32_t ByteIndex) const
 
SIdxRange SubRange (const CUTF8StringView &SubView) const
 
ULANG_FORCEINLINE UnicodeConstIterator begin () const
 
ULANG_FORCEINLINE UnicodeConstIterator end () const
 

Public Attributes

const UTF8Char * _Begin
 Points to first byte.
 
const UTF8Char * _End
 Points to the byte after the last byte.
 

Protected Member Functions

ULANG_FORCEINLINE int32_t InputByteIdxToDirectIdx (int32_t InIdx) const
 
ULANG_FORCEINLINE bool InputByteIdxSpan (int32_t &InOutIdx, int32_t &InOutSpan) const
 

Friends

template<class OtherAllocatorType , typename... OtherAllocatorArgsType>
class TUTF8String
 
template<class OtherAllocatorType , typename... OtherAllocatorArgsType>
class TUTF8StringBuilder
 

Constructor & Destructor Documentation

◆ CUTF8StringView() [1/5]

uLang::CUTF8StringView::CUTF8StringView ( )
inline

◆ CUTF8StringView() [2/5]

uLang::CUTF8StringView::CUTF8StringView ( ENoInit  )
inline

◆ CUTF8StringView() [3/5]

uLang::CUTF8StringView::CUTF8StringView ( const UTF8Char *  Begin,
const UTF8Char *  End 
)
inline

◆ CUTF8StringView() [4/5]

uLang::CUTF8StringView::CUTF8StringView ( const char *  NullterminatedString)
inline

◆ CUTF8StringView() [5/5]

uLang::CUTF8StringView::CUTF8StringView ( const char *  String,
size_t  ByteLen 
)
inline

Member Function Documentation

◆ begin()

ULANG_FORCEINLINE UnicodeConstIterator uLang::CUTF8StringView::begin ( ) const
inline

◆ ByteLen()

ULANG_FORCEINLINE int32_t uLang::CUTF8StringView::ByteLen ( ) const
inline

◆ Contains() [1/2]

ULANG_FORCEINLINE bool uLang::CUTF8StringView::Contains ( const CUTF8StringView &  Text) const
inline

◆ Contains() [2/2]

ULANG_FORCEINLINE bool uLang::CUTF8StringView::Contains ( UTF8Char  Char) const
inline

◆ ContainsCaseIndependent()

ULANG_FORCEINLINE bool uLang::CUTF8StringView::ContainsCaseIndependent ( const CUTF8StringView &  Text) const
inline

◆ Data()

ULANG_FORCEINLINE const UTF8Char * uLang::CUTF8StringView::Data ( ) const
inline

◆ end()

ULANG_FORCEINLINE UnicodeConstIterator uLang::CUTF8StringView::end ( ) const
inline

◆ EndsWith()

ULANG_FORCEINLINE bool uLang::CUTF8StringView::EndsWith ( const CUTF8StringView &  Text) const
inline

◆ Find() [1/2]

ULANG_FORCEINLINE int32_t uLang::CUTF8StringView::Find ( const CUTF8StringView &  Text) const
inline

◆ Find() [2/2]

ULANG_FORCEINLINE int32_t uLang::CUTF8StringView::Find ( UTF8Char  Char) const
inline

◆ FirstByte()

ULANG_FORCEINLINE UTF8Char uLang::CUTF8StringView::FirstByte ( ) const
inline
Returns
the first byte in this string (UTF-8 agnostic) or null character if empty

◆ FirstCodePoint()

ULANG_FORCEINLINE SUniCodePointLength uLang::CUTF8StringView::FirstCodePoint ( ) const
inline
Returns
the first code point in this string (decodes UTF-8)

◆ InputByteIdxSpan()

ULANG_FORCEINLINE bool uLang::CUTF8StringView::InputByteIdxSpan ( int32_t &  InOutIdx,
int32_t &  InOutSpan 
) const
inlineprotected

◆ InputByteIdxToDirectIdx()

ULANG_FORCEINLINE int32_t uLang::CUTF8StringView::InputByteIdxToDirectIdx ( int32_t  InIdx) const
inlineprotected

◆ IsEmpty()

ULANG_FORCEINLINE bool uLang::CUTF8StringView::IsEmpty ( ) const
inline

◆ IsEqualCaseIndependent()

bool uLang::CUTF8StringView::IsEqualCaseIndependent ( const CUTF8StringView &  Other) const
inline

◆ IsFilled()

ULANG_FORCEINLINE bool uLang::CUTF8StringView::IsFilled ( ) const
inline

◆ LastByte()

ULANG_FORCEINLINE UTF8Char uLang::CUTF8StringView::LastByte ( ) const
inline
Returns
the last byte in this string (UTF-8 agnostic) or null character if empty

◆ NextByte()

ULANG_FORCEINLINE UTF8Char uLang::CUTF8StringView::NextByte ( const CUTF8StringView &  Enclosing) const
inline
Returns
the first byte that follows this view (UTF-8 agnostic) or null character if past enclosing string view.

◆ NextNextByte()

ULANG_FORCEINLINE UTF8Char uLang::CUTF8StringView::NextNextByte ( const CUTF8StringView &  Enclosing) const
inline
Returns
the second byte that follows this view (UTF-8 agnostic) or null character if past enclosing string view.

◆ operator!=() [1/2]

bool uLang::CUTF8StringView::operator!= ( const char *  NullterminatedString) const
inline

◆ operator!=() [2/2]

bool uLang::CUTF8StringView::operator!= ( const CUTF8StringView &  Other) const
inline

◆ operator<()

bool uLang::CUTF8StringView::operator< ( const CUTF8StringView &  Other) const
inline

◆ operator<=()

bool uLang::CUTF8StringView::operator<= ( const CUTF8StringView &  Other) const
inline

◆ operator==() [1/2]

bool uLang::CUTF8StringView::operator== ( const char *  NullTerminatedString) const
inline

◆ operator==() [2/2]

bool uLang::CUTF8StringView::operator== ( const CUTF8StringView &  Other) const
inline

◆ operator>()

bool uLang::CUTF8StringView::operator> ( const CUTF8StringView &  Other) const
inline

◆ operator>=()

bool uLang::CUTF8StringView::operator>= ( const CUTF8StringView &  Other) const
inline

◆ operator[]()

ULANG_FORCEINLINE const UTF8Char & uLang::CUTF8StringView::operator[] ( int32_t  ByteIndex) const
inline
Returns
specific byte from this string

◆ PopFirstByte()

ULANG_FORCEINLINE UTF8Char uLang::CUTF8StringView::PopFirstByte ( )
inline
Returns
the first byte in this string (UTF-8 agnostic), and remove it from string

◆ PopFirstCodePoint()

ULANG_FORCEINLINE SUniCodePointLength uLang::CUTF8StringView::PopFirstCodePoint ( )
inline
Returns
the first code point in this string (decodes UTF-8), and remove it from string

◆ Reset()

void uLang::CUTF8StringView::Reset ( )
inline

◆ SecondByte()

ULANG_FORCEINLINE UTF8Char uLang::CUTF8StringView::SecondByte ( ) const
inline
Returns
the second byte in this string (UTF-8 agnostic) or null character if no such character

◆ Set()

void uLang::CUTF8StringView::Set ( const UTF8Char *  Begin,
const UTF8Char *  End 
)
inline

◆ StartsWith()

ULANG_FORCEINLINE bool uLang::CUTF8StringView::StartsWith ( const CUTF8StringView &  Text) const
inline

◆ SubRange()

SIdxRange uLang::CUTF8StringView::SubRange ( const CUTF8StringView &  SubView) const
inline
Returns
Create index range based on sub view of this view.

◆ SubView() [1/2]

ULANG_FORCEINLINE CUTF8StringView uLang::CUTF8StringView::SubView ( const SIdxRange &  Range) const
inline
Returns
a sub view as specified by the range

◆ SubView() [2/2]

ULANG_FORCEINLINE CUTF8StringView uLang::CUTF8StringView::SubView ( int32_t  ByteIndex,
int32_t  ByteCount = INT32_MAX 
) const
inline
Returns
the substring from ByteIndex position for ByteCount bytes

◆ SubViewBegin()

ULANG_FORCEINLINE CUTF8StringView uLang::CUTF8StringView::SubViewBegin ( int32_t  ByteCount) const
inline
Returns
the leftmost given number of bytes

◆ SubViewEmpty()

ULANG_FORCEINLINE CUTF8StringView uLang::CUTF8StringView::SubViewEmpty ( int32_t  ByteIndex) const
inline
Returns
a sub view with both begin and end referring to the byte with the specified index

◆ SubViewEnd()

ULANG_FORCEINLINE CUTF8StringView uLang::CUTF8StringView::SubViewEnd ( int32_t  ByteCount) const
inline
Returns
the string to the right of the specified byte location, counting back from the right (end of the string)

◆ SubViewTrimBegin()

ULANG_FORCEINLINE CUTF8StringView uLang::CUTF8StringView::SubViewTrimBegin ( int32_t  ByteIndex) const
inline
Returns
the string to the right of the specified location, counting forward from the left (from the beginning of the string)

◆ SubViewTrimEnd()

ULANG_FORCEINLINE CUTF8StringView uLang::CUTF8StringView::SubViewTrimEnd ( int32_t  ByteCount) const
inline
Returns
the leftmost bytes from the string chopping the given number of characters from the end

Friends And Related Symbol Documentation

◆ TUTF8String

template<class OtherAllocatorType , typename... OtherAllocatorArgsType>
friend class TUTF8String
friend

◆ TUTF8StringBuilder

template<class OtherAllocatorType , typename... OtherAllocatorArgsType>
friend class TUTF8StringBuilder
friend

Member Data Documentation

◆ _Begin

const UTF8Char* uLang::CUTF8StringView::_Begin

Points to first byte.

◆ _End

const UTF8Char* uLang::CUTF8StringView::_End

Points to the byte after the last byte.

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