Navigation
API > API/Runtime > API/Runtime/Json
JSON Pointer defines a string syntax for identifying a specific value within a JavaScript Object Notation (JSON) document (from rfc6901).
Array append ("-") is currently unsupported.
| Name | FJsonPointer |
| Type | class |
| Header File | /Engine/Source/Runtime/Json/Public/JsonUtils/JsonPointer.h |
| Include Path | #include "JsonUtils/JsonPointer.h" |
Syntax
class FJsonPointer
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FJsonPointer
(
FJsonPointer&& Other |
JsonUtils/JsonPointer.h | ||
FJsonPointer
(
const FJsonPointer& Other |
JsonUtils/JsonPointer.h | ||
FJsonPointer
(
FStringView Path |
JsonUtils/JsonPointer.h | ||
FJsonPointer () |
JsonUtils/JsonPointer.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| PathParts | TArray< FString > | JsonUtils/JsonPointer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Append
(
FStringView Part |
Appends the given part to the path | JsonUtils/JsonPointer.h | |
| Get the path parts as an array. | JsonUtils/JsonPointer.h | ||
FJsonPointer GetSubPath
(
int32 NumParts |
Gets the sub-path up to the given part length. | JsonUtils/JsonPointer.h | |
bool IsValid() |
Checks that the path has one or more parts. | JsonUtils/JsonPointer.h | |
int32 Length() |
The number of parts in the path. | JsonUtils/JsonPointer.h | |
void SetArrayIndex
(
int32 Index |
Sets the last path part to the given array index. | JsonUtils/JsonPointer.h | |
FString ToString() |
Get the JsonPointer's string representation. | JsonUtils/JsonPointer.h | |
bool TryGet
(
const TSharedPtr< FJsonValue >& RootValue, |
Attempt to retrieve the value specified by this Json Pointer from the provided Json Object. | JsonUtils/JsonPointer.h | |
bool TryGet
(
const TSharedPtr< FJsonObject >& RootObject, |
Attempt to retrieve the value specified by this Json Pointer from the provided Json Value. | JsonUtils/JsonPointer.h | |
bool TryGet
(
const TArray< TSharedPtr< FJsonValue > >& RootValues, |
Attempt to retrieve the value specified by this Json Pointer from the provided Json Array. | JsonUtils/JsonPointer.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Substitutes characters in the provided Part with their escaped counterparts (as per the spec). | JsonUtils/JsonPointer.h | ||
| Substitutes escaped characters in the Provided path with their original character (as per the spec). | JsonUtils/JsonPointer.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FString & operator[]
(
int32 Idx |
Get the path part at the given index. | JsonUtils/JsonPointer.h |