Documentation
¶
Index ¶
- func CreateStrategicMergePatch(original, modified []byte, dataStruct interface{}) ([]byte, error)deprecated
- func CreateThreeWayMergePatch(original, modified, current []byte, dataStruct interface{}, force bool, ...) ([]byte, error)
- func CreateTwoWayMergePatch(original, modified []byte, dataStruct interface{}, fns ...PreconditionFunc) ([]byte, error)
- func HasConflicts(left, right interface{}) (bool, error)
- func IsConflict(err error) bool
- func IsPreconditionFailed(err error) bool
- func StrategicMergePatch(original, patch []byte, dataStruct interface{}) ([]byte, error)
- func StrategicMergePatchData(original, patch []byte, dataStruct interface{}) ([]byte, error)deprecated
- type PreconditionFunc
- type SortableSliceOfMaps
- type SortableSliceOfScalars
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateStrategicMergePatch
deprecated
added in
v1.1.0
func CreateStrategicMergePatch(original, modified []byte, dataStruct interface{}) ([]byte, error)
Deprecated: Use the synonym CreateTwoWayMergePatch, instead.
func CreateThreeWayMergePatch ¶ added in v1.1.1
func CreateThreeWayMergePatch(original, modified, current []byte, dataStruct interface{}, force bool, fns ...PreconditionFunc) ([]byte, error)
CreateThreeWayMergePatch reconciles a modified configuration with an original configuration, while preserving any changes or deletions made to the original configuration in the interim, and not overridden by the current configuration. All three documents must be passed to the method as json encoded content. It will return a strategic merge patch, or an error if any of the documents is invalid, or if there are any preconditions that fail against the modified configuration, or, if force is false and there are conflicts between the modified and current configurations.
func CreateTwoWayMergePatch ¶ added in v1.1.1
func CreateTwoWayMergePatch(original, modified []byte, dataStruct interface{}, fns ...PreconditionFunc) ([]byte, error)
CreateTwoWayMergePatch creates a patch that can be passed to StrategicMergePatch from an original document and a modified documernt, which are passed to the method as json encoded content. It will return a patch that yields the modified document when applied to the original document, or an error if either of the two documents is invalid.
func HasConflicts ¶ added in v1.1.1
func HasConflicts(left, right interface{}) (bool, error)
HasConflicts returns true if the left and right JSON interface objects overlap with different values in any key. All keys are required to be strings. Since patches of the same Type have congruent keys, this is valid for multiple patch types.
func IsConflict ¶ added in v1.1.1
func IsConflict(err error) bool
IsConflict returns true if the provided error indicates a conflict between the patch and the current configuration.
func IsPreconditionFailed ¶ added in v1.1.1
func IsPreconditionFailed(err error) bool
IsPreconditionFailed returns true if the provided error indicates a precondition failed.
func StrategicMergePatch ¶ added in v1.1.0
func StrategicMergePatch(original, patch []byte, dataStruct interface{}) ([]byte, error)
StrategicMergePatch applies a strategic merge patch. The patch and the original document must be json encoded content. A patch can be created from an original and a modified document by calling CreateStrategicMergePatch.
func StrategicMergePatchData
deprecated
func StrategicMergePatchData(original, patch []byte, dataStruct interface{}) ([]byte, error)
Deprecated: StrategicMergePatchData is deprecated. Use the synonym StrategicMergePatch, instead, which follows the naming convention of evanphx/json-patch.
Types ¶
type PreconditionFunc ¶ added in v1.1.1
type PreconditionFunc func(interface{}) bool
PreconditionFunc asserts that an incompatible change is not present within a patch.
func RequireKeyUnchanged ¶ added in v1.1.1
func RequireKeyUnchanged(key string) PreconditionFunc
RequireKeyUnchanged returns a precondition function that fails if the provided key is present in the patch (indicating that its value has changed).
type SortableSliceOfMaps ¶
type SortableSliceOfMaps struct {
// contains filtered or unexported fields
}
type SortableSliceOfScalars ¶
type SortableSliceOfScalars struct {
// contains filtered or unexported fields
}
Source Files