1. Epic GamesDeveloper
  3. FAsciiSet

FAsciiSet

ASCII character bitset useful for fast and readable parsing

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Misc

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Misc/AsciiSet.h
Include #include "Misc/AsciiSet.h"

Syntax

class FAsciiSet

Remarks

ASCII character bitset useful for fast and readable parsing

Entirely constexpr. Works with both wide and narrow strings.

Example use cases:

constexpr FAsciiSet WhitespaceCharacters(" \v\f\t\r\n"); bool bIsWhitespace = WhitespaceCharacters.Test(MyChar); const char* HelloWorld = FAsciiSet::Skip(" \t\tHello world!", WhitespaceCharacters);

constexpr FAsciiSet XmlEscapeChars("&<>"'"); check(FAsciiSet::HasNone(EscapedXmlString, XmlEscapeChars));

constexpr FAsciiSet Delimiters(".:;"); const TCHAR* DelimiterOrEnd = FAsciiSet::FindFirstOrEnd(PrefixedName, Delimiters); FString Prefix(PrefixedName, DelimiterOrEnd - PrefixedName);

constexpr FAsciiSet Slashes("/\"); const TCHAR* SlashOrEnd = FAsciiSet::FindLastOrEnd(PathName, Slashes); const TCHAR* FileName = *SlashOrEnd ? SlashOrEnd + 1 : PathName;

Constructors

  Type Name Description
Public function constexpr

FAsciiSet ( const CharType(&) Chars
)

  

Functions

  Type Name Description
Public function Const bool

Contains ( CharType Char
)

 Returns true if a character is part of the set
Public function Static const CharType *

FindFirstOrEnd ( const CharType* Str,
FAsciiSet Set
)

 Find first character of string inside set or end pointer. Never returns null.
Public function Static const CharType *

FindLastOrEnd ( const CharType* Str,
FAsciiSet Set
)

 Find last character of string inside set or end pointer. Never returns null.
Public function Static StringType

FindPrefixWith ( const StringType& Str,
FAsciiSet Set
)

 Get initial substring with all characters in set
Public function Static StringType

FindPrefixWithout ( const StringType& Str,
FAsciiSet Set
)

 Get initial substring with no characters in set
Public function Static StringType

FindSuffixWith ( const StringType& Str,
FAsciiSet Set
)

 Get trailing substring with all characters in set
Public function Static StringType

FindSuffixWithout ( const StringType& Str,
FAsciiSet Set
)

 Get trailing substring with no characters in set
Public function Static bool

HasAny ( const StringType& Str,
FAsciiSet Set
)

 Test if string contains any character in set
Public function Static bool

HasAny ( const CharType* Str,
FAsciiSet Set
)

 Test if string contains any character in set
Public function Static bool

HasNone ( const StringType& Str,
FAsciiSet Set
)

 Test if string contains no character in set
Public function Static bool

HasNone ( const CharType* Str,
FAsciiSet Set
)

 Test if string contains no character in set
Public function Static bool

HasOnly ( const StringType& Str,
FAsciiSet Set
)

 Test if string contains any character outside of set
Public function Static bool

HasOnly ( const CharType* Str,
FAsciiSet Set
)

 Test if string contains any character outside of set
Public function Static const CharType *

Skip ( const CharType* Str,
FAsciiSet Set
)

 Find first character of string outside of set. Never returns null.
Public function Const uint64

Test ( CharType Char
)

 Returns non-zero if a character is part of the set.
Public function Static StringType

TrimPrefixWith ( const StringType& Str,
FAsciiSet Set
)

 Trim initial characters in set
Public function Static StringType

TrimPrefixWithout ( const StringType& Str,
FAsciiSet Set
)

 Trim initial characters not in set
Public function Static StringType

TrimSuffixWith ( const StringType& Str,
FAsciiSet Set
)

 Trim trailing characters in set
Public function Static StringType

TrimSuffixWithout ( const StringType& Str,
FAsciiSet Set
)

 Trim trailing characters not in set

Operators

  Type Name Description
Public function Const FAsciiSet

operator& ( FAsciiSet OtherSet
)

 Create new set containing only the characters that exist in both this and another specified set
Public function Const FAsciiSet

operator| ( FAsciiSet OtherSet
)

 Create new set containing the combination of this set and another
Public function Const FAsciiSet Create new set containing inverse set of characters - likely including null-terminator
Public function Const FAsciiSet

operator+ ( char Char
)

 Create new set with specified character in it

Enums

  Type Name Description
Private enum EDir    
Private enum EInclude    
Private enum EKeep    

Constants

Name Description
NilMask  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page