CompactBinaryValidation.cpp File Reference

#include "Serialization/CompactBinaryValidation.h"
#include "Algo/Sort.h"
#include "Compression/CompressedBuffer.h"
#include "Containers/Array.h"
#include "Containers/ArrayView.h"
#include "Containers/ContainerAllocationPolicies.h"
#include "Containers/ContainersFwd.h"
#include "Containers/StringFwd.h"
#include "Containers/StringView.h"
#include "HAL/PlatformMemory.h"
#include "IO/IoHash.h"
#include "Memory/MemoryView.h"
#include "Memory/SharedBuffer.h"
#include "Misc/ByteSwap.h"
#include "Serialization/CompactBinary.h"
#include "Serialization/CompactBinaryPackage.h"
#include "Serialization/VarInt.h"

Classes
class	FCbUniformFieldsValidator

Functions
ECbValidateError	ValidateCompactBinary (FMemoryView View, ECbValidateMode Mode, ECbFieldType Type)
ECbValidateError	ValidateCompactBinaryRange (FMemoryView View, ECbValidateMode Mode)
ECbValidateError	ValidateCompactBinaryAttachment (FMemoryView View, ECbValidateMode Mode)
ECbValidateError	ValidateCompactBinaryPackage (FMemoryView View, ECbValidateMode Mode)
ECbValidateError	ValidateCompactBinary (const FCbField &Value, ECbValidateMode Mode)
ECbValidateError	ValidateCompactBinary (const FCbArray &Value, ECbValidateMode Mode)
ECbValidateError	ValidateCompactBinary (const FCbObject &Value, ECbValidateMode Mode)
ECbValidateError	ValidateCompactBinary (const FCbPackage &Value, ECbValidateMode Mode)
ECbValidateError	ValidateCompactBinary (const FCbAttachment &Value, ECbValidateMode Mode)

Function Documentation

ValidateCompactBinary() [1/6]

ECbValidateError ValidateCompactBinary	(	const FCbArray &	Value,
		ECbValidateMode	Mode
	)

ValidateCompactBinary() [2/6]

ECbValidateError ValidateCompactBinary	(	const FCbAttachment &	Value,
		ECbValidateMode	Mode
	)

ValidateCompactBinary() [3/6]

ECbValidateError ValidateCompactBinary	(	const FCbField &	Value,
		ECbValidateMode	Mode
	)

Validate the compact binary data for one value as specified by the mode flags.

Validation recurses into attachments, objects, arrays, and fields within the top-level value.

Returns

None on success, otherwise the flags for the types of errors that were detected.

ValidateCompactBinary() [4/6]

ECbValidateError ValidateCompactBinary	(	const FCbObject &	Value,
		ECbValidateMode	Mode
	)

ValidateCompactBinary() [5/6]

ECbValidateError ValidateCompactBinary	(	const FCbPackage &	Value,
		ECbValidateMode	Mode
	)

ValidateCompactBinary() [6/6]

ECbValidateError ValidateCompactBinary	(	FMemoryView	View,
		ECbValidateMode	Mode,
		ECbFieldType	Type = ECbFieldType::HasFieldType
	)

Validate the compact binary data for one field in the view as specified by the mode flags.

Only one top-level field is processed from the view, and validation recurses into any array or object within that field. To validate multiple consecutive top-level fields, call the function once for each top-level field. If the given view might contain multiple top-level fields, then either exclude the Padding flag from the Mode or use MeasureCompactBinary to break up the view into its constituent fields before validating.

Parameters

View	A memory view containing at least one top-level field.
Mode	A combination of the flags for the types of validation to perform.
Type	HasFieldType means that View contains the type. Otherwise, use the given type.

Returns

None on success, otherwise the flags for the types of errors that were detected.

ValidateCompactBinaryAttachment()

ECbValidateError ValidateCompactBinaryAttachment	(	FMemoryView	View,
		ECbValidateMode	Mode
	)

Validate the compact binary attachment pointed to by the view as specified by the mode flags.

The attachment is validated with ValidateCompactBinary by using the validation mode specified. Include ECbValidateMode::Package to validate the attachment format and hash.

See also

ValidateCompactBinary

Parameters

View	A memory view containing a package.
Mode	A combination of the flags for the types of validation to perform.

Returns

None on success, otherwise the flags for the types of errors that were detected.

ValidateCompactBinaryPackage()

ECbValidateError ValidateCompactBinaryPackage	(	FMemoryView	View,
		ECbValidateMode	Mode
	)

Validate the compact binary package pointed to by the view as specified by the mode flags.

The package, and attachments, are validated with ValidateCompactBinary by using the validation mode specified. Include ECbValidateMode::Package to validate the package format and hashes.

See also

ValidateCompactBinary

Parameters

View	A memory view containing a package.
Mode	A combination of the flags for the types of validation to perform.

Returns

None on success, otherwise the flags for the types of errors that were detected.

ValidateCompactBinaryRange()

ECbValidateError ValidateCompactBinaryRange	(	FMemoryView	View,
		ECbValidateMode	Mode
	)

Validate the compact binary data for every field in the view as specified by the mode flags.

This function expects the entire view to contain fields. Any trailing region of the view which does not contain a valid field will produce an OutOfBounds or InvalidType error instead of the Padding error that would be produced by the single field validation function.

See also

ValidateCompactBinary