filter

Documentation

Index

• Variables
• type Filter
  • func (f *Filter) IsValid() error
  • func (f *Filter) UnmarshalJSON(data []byte) error
• type FilterList
  • func (f *FilterList) IsValid() error
  • func (f *FilterList) UnmarshalParam(value string) error
• type FilterTypeOperator
• type FilterTypeProperty

Variables

var (
	ErrFilterTypeUnknow       = errors.New("unknow filter type")
	ErrPropertyNameInvalid    = errors.New("invalid property name")
	ErrPropertyOperatorUnknow = errors.New("unknow property operator")
)

Types

type Filter

type Filter struct {
	Type   string      `json:"type,omitempty"`
	Params interface{} `json:"params,omitempty"`
}

Filter holds data for filtering results in a query.

func (*Filter) IsValid

func (f *Filter) IsValid() error

IsValid check if is valid.

func (*Filter) UnmarshalJSON

func (f *Filter) UnmarshalJSON(data []byte) error

type FilterList

type FilterList []*Filter //nolint:revive

FilterList is a slice of Filter.

func (*FilterList) IsValid

func (f *FilterList) IsValid() error

IsValid check if filter list is valid.

func (*FilterList) UnmarshalParam

func (f *FilterList) UnmarshalParam(value string) error

UnmarshalParam converts a base64 filter string to a FilterList.

type FilterTypeOperator

type FilterTypeOperator struct {
	// Conditional operator name
	//
	// and: AND conditional operator
	// or: OR conditional operator
	Name string `json:"name"`
}

FilterTypeOperator holds data to apply a conditional operator in a filter.

type FilterTypeProperty

type FilterTypeProperty struct {
	// Property name
	Name string `json:"name"`
	// Comparison operator
	//
	// contains: check if property contains the value
	// eq: check if the property is equal to value
	// bool: check if the property is true or false based on value
	// gt: check if the property is greater than value
	// lt: check if the property is less than value
	Operator string `json:"operator"`
	// Value to compare
	Value interface{} `json:"value"`
}

FilterTypeProperty holds data to filter a property based on value and comparison operator.