Open 3D Engine AzCore API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::StackedString Class Reference

Public Types

enum class  Format { ContextPath , JsonPointer }
 

Public Member Functions

 StackedString (Format format)
 
void Push (AZStd::string_view value)
 
void Push (size_t value)
 Push an integer value to the stack. The value will be converted to a string.
 
void Pop ()
 
void Reset ()
 Resets the StackedString to it's default and frees all memory.
 
AZStd::string_view Get () const
 
 operator AZStd::string_view () const
 

Member Enumeration Documentation

◆ Format

enum class AZ::StackedString::Format
strong
Enumerator
ContextPath 

String is formatted to mirror the SerializeContext such as "class.array.0.element".

JsonPointer 

String is formatted as a JSON Pointer such as "/class/array/0/element".

Member Function Documentation

◆ Push()

void AZ::StackedString::Push ( AZStd::string_view  value)

Push a new string part onto the stack. Only supports a single reference token i.e appending "Foo" onto "/O3DE" results in "/O3DE/Foo" However appending "TokenWith/ForwardSlash" results in "/O3DE/Foo/TokenWith~1ForwardSlash" as the forward slash is seen as part of a single reference token and encoded. See the JSON pointer path spec for more info: https://www.rfc-editor.org/rfc/rfc6901#section-3


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