filter

Documentation

Index

• Variables
• func IsQueryField(field string) bool
• type FieldValue
  • func NewFieldValue(field string) FieldValue
  • func (fv FieldValue) Evaluate(fields any) (interface{}, error)
• type Filter
  • func MustNew(field, rawOp string, value interface{}) Filter
  • func New(field, rawOp string, value interface{}) (Filter, error)
  • func Parse(filter string) (Filter, error)
  • func (f Filter) Match(fields any) (bool, error)
  • func (f Filter) String() string
• type Operator

Variables

var (
	ErrInvalidFilterFormat     = errors.New("invalid filter format")
	ErrUnknownFieldName        = errors.New("unknown field name")
	ErrUnsupportedOperatorType = errors.New("unknown operator name")
	ErrInvalidValueFormat      = errors.New("unknown field value format")
)

var (
	ErrMustBePointer                = errors.New("fields value must be a pointer")
	ErrFieldNotFound                = errors.New("field was not found")
	ErrFieldInvalidValueType        = errors.New("field value contains invalid type")
	ErrFieldUnsupportedOperatorType = errors.New("field value does not support provided operator")
)

Functions

func IsQueryField

func IsQueryField(field string) bool

Types

type FieldValue

type FieldValue struct {
	// contains filtered or unexported fields
}

func NewFieldValue

func NewFieldValue(field string) FieldValue

func (FieldValue) Evaluate

func (fv FieldValue) Evaluate(fields any) (interface{}, error)

Evaluate obtains the actual value from the provided fieldset The obtained value is then used for comparison, such as numplayers!=maxplayers

type Filter

type Filter struct {
	// contains filtered or unexported fields
}

func MustNew

func MustNew(field, rawOp string, value interface{}) Filter

func New

func New(field, rawOp string, value interface{}) (Filter, error)

func Parse

func Parse(filter string) (Filter, error)

Parse accepts a string in the form of "<field><op><value>" that represents a single filter value for the specified server field. Examples: numplayers!=maxplayers, password=0, gamevariant='SWAT 4' Returns an instance of Filter

func (Filter) Match

func (f Filter) Match(fields any) (bool, error)

Match checks whether this filter instance matches either of the provided field set

func (Filter) String

func (f Filter) String() string

type Operator

type Operator int

const (
	EQ Operator = iota
	NE
	LT
	GT
)