nip

Documentation

Index

• Variables
• type Rule
  • func NewRule(rawRule string, filename string, lineNumber int) (Rule, error)
  • func (r Rule) Evaluate(it data.Item) (RuleResult, error)
  • func (r Rule) MaxQuantity() int
• type RuleResult
• type Rules
  • func ParseNIPFile(filePath string) (Rules, error)
  • func ReadDir(path string) (Rules, error)
  • func (r Rules) EvaluateAll(it data.Item) (Rule, RuleResult)

Variables

var (
	// ErrEmptyRule is returned when a rule is empty
	ErrEmptyRule = errors.New("empty rule")
)

var StatAliases = statAliases

var TypeAliases = typeAliases

Types

type Rule

type Rule struct {
	RawLine    string // Original line, don't use it for evaluation
	Filename   string
	LineNumber int
	Enabled    bool
	// contains filtered or unexported fields
}

func NewRule

func NewRule(rawRule string, filename string, lineNumber int) (Rule, error)

func (Rule) Evaluate

func (r Rule) Evaluate(it data.Item) (RuleResult, error)

func (Rule) MaxQuantity

func (r Rule) MaxQuantity() int

MaxQuantity returns the maximum quantity of items that character can have, 0 means no limit

type RuleResult

type RuleResult int

const (
	RuleResultFullMatch RuleResult = 1
	RuleResultPartial   RuleResult = 2
	RuleResultNoMatch   RuleResult = 3
)

type Rules

type Rules []Rule

func ParseNIPFile

func ParseNIPFile(filePath string) (Rules, error)

func ReadDir

func ReadDir(path string) (Rules, error)

func (Rules) EvaluateAll

func (r Rules) EvaluateAll(it data.Item) (Rule, RuleResult)