index

Documentation

Index

• func Get(templateID string, parameters rule.Parameters) (rule.Evaluator, error)
• func Register(meta *Metadata, factory rule.Factory, validator ...rule.Validator)
• func Valid(templateID string, parameters rule.Parameters) error
• type IndexedParam
• type Metadata
  • func Index() []*Metadata

Functions

func Get

func Get(templateID string, parameters rule.Parameters) (rule.Evaluator, error)

Get rule evaluator with the provided template ID

func Register

func Register(meta *Metadata, factory rule.Factory, validator ...rule.Validator)

Register the rule evaluator with the corresponding rule template

func Valid

func Valid(templateID string, parameters rule.Parameters) error

Valid ...

Types

type IndexedParam

type IndexedParam struct {
	Name string `json:"name"`

	// Type of the param
	// "int", "string" or "[]string"
	Type string `json:"type"`

	Unit string `json:"unit"`

	Required bool `json:"required"`
}

IndexedParam declares the param info

type Metadata

type Metadata struct {
	TemplateID string `json:"rule_template"`

	// Action of the rule performs
	// "retain"
	Action string `json:"action"`

	Parameters []*IndexedParam `json:"params"`
}

Metadata defines metadata for rule registration

func Index

func Index() []*Metadata

Index returns all the metadata of the registered rules