anchor

Documentation

Index

• func ContainsCondition(a Anchor) bool
• func GetAnchorsResourcesFromMap(patternMap map[string]interface{}) (map[string]interface{}, map[string]interface{})
• func IsAddIfNotPresent(a Anchor) bool
• func IsCondition(a Anchor) bool
• func IsConditionalAnchorError(err error) bool
• func IsEquality(a Anchor) bool
• func IsExistence(a Anchor) bool
• func IsGlobal(a Anchor) bool
• func IsGlobalAnchorError(err error) bool
• func IsNegation(a Anchor) bool
• func IsNegationAnchorError(err error) bool
• func IsOneOf(a Anchor, types ...AnchorType) bool
• func RemoveAnchorsFromPath(str string) string
• func String(modifier AnchorType, key string) string
• type Anchor
  • func New(modifier AnchorType, key string) Anchor
  • func Parse(str string) Anchor
• type AnchorMap
  • func NewAnchorMap() *AnchorMap
  • func (ac *AnchorMap) CheckAnchorInResource(pattern map[string]interface{}, resource interface{})
  • func (ac *AnchorMap) KeysAreMissing() bool
• type AnchorType
• type ValidationHandler
  • func CreateElementHandler(element string, pattern interface{}, path string) ValidationHandler

Functions

func ContainsCondition

func ContainsCondition(a Anchor) bool

ContainsCondition returns true if anchor is either condition anchor or global condition anchor

func GetAnchorsResourcesFromMap

func GetAnchorsResourcesFromMap(patternMap map[string]interface{}) (map[string]interface{}, map[string]interface{})

GetAnchorsResourcesFromMap returns maps of anchors and resources

func IsAddIfNotPresent

func IsAddIfNotPresent(a Anchor) bool

IsAddIfNotPresent checks for addition anchor

func IsCondition

func IsCondition(a Anchor) bool

IsCondition checks for condition anchor

func IsConditionalAnchorError

func IsConditionalAnchorError(err error) bool

IsConditionalAnchorError checks if error is a conditional anchor error

func IsEquality

func IsEquality(a Anchor) bool

IsEquality checks for equality anchor

func IsExistence

func IsExistence(a Anchor) bool

IsExistence checks for existence anchor

func IsGlobal

func IsGlobal(a Anchor) bool

IsGlobal checks for global condition anchor

func IsGlobalAnchorError

func IsGlobalAnchorError(err error) bool

IsGlobalAnchorError checks if error is a global global anchor error

func IsNegation

func IsNegation(a Anchor) bool

IsNegation checks for negation anchor

func IsNegationAnchorError

func IsNegationAnchorError(err error) bool

IsNegationAnchorError checks if error is a negation anchor error

func IsOneOf

func IsOneOf(a Anchor, types ...AnchorType) bool

IsOneOf returns checks if anchor is one of the given types

func RemoveAnchorsFromPath

func RemoveAnchorsFromPath(str string) string

RemoveAnchorsFromPath removes all anchor from path string

func String

func String(modifier AnchorType, key string) string

String returns the anchor string. Will return an empty string if key is empty.

Types

type Anchor

type Anchor interface {
	// Type returns the anchor type
	Type() AnchorType
	// Key returns the anchor key
	Key() string
	// String returns the anchor string
	String() string
}

Anchor interface

func New

func New(modifier AnchorType, key string) Anchor

New creates an anchor

func Parse

func Parse(str string) Anchor

Parse parses a string, returns nil if not an anchor

type AnchorMap

type AnchorMap struct {

	// AnchorError - used in validate to break execution of the recursion when if condition fails
	AnchorError validateAnchorError
	// contains filtered or unexported fields
}

AnchorMap - contains map of anchors

func NewAnchorMap

func NewAnchorMap() *AnchorMap

NewAnchorMap -initialize anchorMap

func (*AnchorMap) CheckAnchorInResource

func (ac *AnchorMap) CheckAnchorInResource(pattern map[string]interface{}, resource interface{})

CheckAnchorInResource checks if condition anchor key has values

func (*AnchorMap) KeysAreMissing

func (ac *AnchorMap) KeysAreMissing() bool

KeysAreMissing - if any of the anchor key doesn't exists in the resource then it will return true if any of (key)=false then return KeysAreMissing() as true if all the keys exists in the pattern exists in resource then return KeysAreMissing() as false

type AnchorType

type AnchorType string

const (
	Condition       AnchorType = ""
	Global          AnchorType = "<"
	Negation        AnchorType = "X"
	AddIfNotPresent AnchorType = "+"
	Equality        AnchorType = "="
	Existence       AnchorType = "^"
)

type ValidationHandler

type ValidationHandler interface {
	Handle(
		handler resourceElementHandler,
		resourceMap map[string]interface{},
		originPattern interface{},
		ac *AnchorMap,
	) (string, error)
}

ValidationHandler for element processes

func CreateElementHandler

func CreateElementHandler(element string, pattern interface{}, path string) ValidationHandler

CreateElementHandler factory to process elements