Structured JSON Patch (RFC 6902) / Merge Patch (RFC 7396) failure. Patch application is atomic: failure leaves the target unchanged. Reporting patch APIs reset all fields on entry and on success. More...

#include <pjson.h>

Public Types
enum	Code { Ok , InvalidPatchDocument , OperationNotObject , MissingOp , MissingPath , MissingFrom , MissingValue , InvalidOp , InvalidPath , InvalidFrom , TargetMissing , InvalidArrayIndex , ArrayIndexOutOfRange , MoveRootNotAllowed , MoveIntoDescendant , TestFailed , ResourceLimit , AllocationFailure , InternalError }
	Selects one of the public JSON policies. More...

Public Member Functions
	PatchError ()
	Public API member `PatchError`; see the API overview for its contract.

Public Attributes
bool	ok
	Public API member `ok`; see the API overview for its contract.

Code	code
	Public API member `code`; see the API overview for its contract.

size_t	opIndex
	Public API member `opIndex`; see the API overview for its contract.

std::string	op
	Public API member `op`; see the API overview for its contract.

std::string	path
	Public API member `path`; see the API overview for its contract.

std::string	from
	Public API member `from`; see the API overview for its contract.

size_t	tokenIndex
	Public API member `tokenIndex`; see the API overview for its contract.

std::string	token
	Public API member `token`; see the API overview for its contract.

std::string	message
	Public API member `message`; see the API overview for its contract. / Constructs a successful patch state with no operation or token details.

Detailed Description

Structured JSON Patch (RFC 6902) / Merge Patch (RFC 7396) failure. Patch application is atomic: failure leaves the target unchanged. Reporting patch APIs reset all fields on entry and on success.

Definition at line 182 of file pjson.h.

Member Enumeration Documentation

◆ Code

enum ByteDance::pjson::PatchError::Code

Selects one of the public JSON policies.

Enumerator
Ok	JSON value or policy constant.
InvalidPatchDocument	JSON value or policy constant.
OperationNotObject	JSON value or policy constant.
MissingOp	JSON value or policy constant.
MissingPath	JSON value or policy constant.
MissingFrom	JSON value or policy constant.
MissingValue	JSON value or policy constant.
InvalidOp	JSON value or policy constant.
InvalidPath	JSON value or policy constant.
InvalidFrom	JSON value or policy constant.
TargetMissing	JSON value or policy constant.
InvalidArrayIndex	JSON value or policy constant.
ArrayIndexOutOfRange	JSON value or policy constant.
MoveRootNotAllowed	JSON value or policy constant.
MoveIntoDescendant	JSON value or policy constant.
TestFailed	JSON value or policy constant.
ResourceLimit	JSON value or policy constant.
AllocationFailure	JSON value or policy constant.
InternalError	JSON value or policy constant.

Definition at line 184 of file pjson.h.

Constructor & Destructor Documentation

◆ PatchError()

ByteDance::pjson::PatchError::PatchError ( )

Public API member PatchError; see the API overview for its contract.

Member Data Documentation

◆ code

Code ByteDance::pjson::PatchError::code

Public API member code; see the API overview for its contract.

Definition at line 207 of file pjson.h.

◆ from

std::string ByteDance::pjson::PatchError::from

Public API member from; see the API overview for its contract.

Definition at line 211 of file pjson.h.

◆ message

std::string ByteDance::pjson::PatchError::message

Public API member message; see the API overview for its contract. / Constructs a successful patch state with no operation or token details.

Definition at line 214 of file pjson.h.

◆ ok

bool ByteDance::pjson::PatchError::ok

Public API member ok; see the API overview for its contract.

Definition at line 206 of file pjson.h.

◆ op

std::string ByteDance::pjson::PatchError::op

Public API member op; see the API overview for its contract.

Definition at line 209 of file pjson.h.

◆ opIndex

size_t ByteDance::pjson::PatchError::opIndex

Public API member opIndex; see the API overview for its contract.

Definition at line 208 of file pjson.h.

◆ path

std::string ByteDance::pjson::PatchError::path

Public API member path; see the API overview for its contract.

Definition at line 210 of file pjson.h.

◆ token

std::string ByteDance::pjson::PatchError::token

Public API member token; see the API overview for its contract.

Definition at line 213 of file pjson.h.

◆ tokenIndex

size_t ByteDance::pjson::PatchError::tokenIndex

Public API member tokenIndex; see the API overview for its contract.

Definition at line 212 of file pjson.h.

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

pjsonlib/include/pjson.h

Public Types

Public Member Functions

Public Attributes