AZ::Dom::DeltaPatchGenerationParameters Struct Reference

Parameters for GenerateHierarchicalDeltaPatch. More...

#include <DomComparison.h>

Public Attributes
size_t	m_replaceThreshold = 3
bool	m_generateDenormalizedPaths = false
AZStd::function< bool(const Value &before, const Value &after)>	m_allowReplacement

Static Public Attributes
static constexpr size_t	NoReplace = AZStd::numeric_limits<size_t>::max()
static constexpr size_t	AlwaysFullReplace = 0

Detailed Description

Parameters for GenerateHierarchicalDeltaPatch.

Member Data Documentation

m_allowReplacement

AZStd::function<bool(const Value& before, const Value& after)> AZ::Dom::DeltaPatchGenerationParameters::m_allowReplacement

this is an optional function that specifies whether to allow generation of a delta replacement patch that replaces the entire

Parameters

before	value with the
after	value once at least m_replaceThreshold changes have been detected

m_generateDenormalizedPaths

bool AZ::Dom::DeltaPatchGenerationParameters::m_generateDenormalizedPaths = false

If set, the patches generated will avoid using "EndOfPath" entries in favor of explicitly specifying indices. This will generate nonconformant JSON patches, but can be useful if there's downstream book-keeping for the patch paths themselves. This is used by e.g. DocumentPropertyEditor so that systems can handle patches without introspecting the previous DOM to generate indices.

m_replaceThreshold

size_t AZ::Dom::DeltaPatchGenerationParameters::m_replaceThreshold = 3

The threshold of changed values in a node or array which, if exceeded, will cause the generation to create an entire "replace" operation instead. If set to NoReplace, no replacement will occur.

---

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

• Code/Framework/AzCore/AzCore/DOM/DomComparison.h