filter

package
v0.0.0-...-3b2b5cc Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 8, 2026 License: MIT Imports: 20 Imported by: 1

Documentation

Overview

Package filter 定义可序列化的过滤规则模型及其组合方式。

Package filter GENERATED BY gengo:enum DON'T EDIT THIS FILE

Package filter GENERATED BY gengo:runtimedoc DON'T EDIT THIS FILE

Index

Constants

This section is empty.

Variables

View Source 
var InvalidOp = errors.New("invalid Op")

Functions

func First 

func First[A Arg, O any](args iter.Seq[A], where func(a Arg) (O, bool)) (O, bool)

First 返回首个命中条件的映射结果。

func MapFilter 

func MapFilter[T comparable, A Arg, O any](args iter.Seq[A], where func(a *Filter[T]) (O, bool)) iter.Seq[O]

MapFilter 过滤并映射指定类型的 Filter 参数。

func MapWhere 

func MapWhere[A Arg, O any](args iter.Seq[A], where func(a Arg) (O, bool)) iter.Seq[O]

MapWhere 过滤并映射参数序列。

Types

type Arg 

type Arg interface {
	encoding.TextMarshaler
}

Arg 表示可序列化的过滤参数。

type Composed 

type Composed struct {
	Filters []any
	// contains filtered or unexported fields
}

Composed 表示组合后的过滤条件集合。

func Compose 

func Compose(filters ...any) *Composed

Compose 根据结构体中的规则表达式组合查询条件。

func (Composed) IsZero 

func (c Composed) IsZero() bool

func (Composed) MarshalText 

func (c Composed) MarshalText() ([]byte, error)

func (*Composed) RuntimeDoc 

func (v *Composed) RuntimeDoc(names ...string) ([]string, bool)

func (*Composed) UnmarshalText 

func (c *Composed) UnmarshalText(data []byte) error

type ErrInvalidFilter 

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

ErrInvalidFilter 表示过滤表达式非法。

func (*ErrInvalidFilter) Error 

func (e *ErrInvalidFilter) Error() string

func (*ErrInvalidFilter) RuntimeDoc 

func (v *ErrInvalidFilter) RuntimeDoc(names ...string) ([]string, bool)

func (ErrInvalidFilter) StatusCode 

func (ErrInvalidFilter) StatusCode() int

type ErrInvalidFilterOp 

type ErrInvalidFilterOp struct {
	Op string
	// contains filtered or unexported fields
}

ErrInvalidFilterOp 表示过滤操作符非法。

func (*ErrInvalidFilterOp) Error 

func (e *ErrInvalidFilterOp) Error() string

func (*ErrInvalidFilterOp) RuntimeDoc 

func (v *ErrInvalidFilterOp) RuntimeDoc(names ...string) ([]string, bool)

func (ErrInvalidFilterOp) StatusCode 

func (ErrInvalidFilterOp) StatusCode() int

type ErrUnsupportedQLField 

type ErrUnsupportedQLField struct {
	FieldName string
	// contains filtered or unexported fields
}

ErrUnsupportedQLField 表示查询字段不受支持。

func (*ErrUnsupportedQLField) Error 

func (e *ErrUnsupportedQLField) Error() string

func (*ErrUnsupportedQLField) RuntimeDoc 

func (v *ErrUnsupportedQLField) RuntimeDoc(names ...string) ([]string, bool)

func (ErrUnsupportedQLField) StatusCode 

func (ErrUnsupportedQLField) StatusCode() int

type Filter 

type Filter[T comparable] struct {
	// contains filtered or unexported fields
}

Filter 表示一条具体过滤规则。

func And 

func And[T comparable](filters ...TypedRule[T]) *Filter[T]

And 构造多个条件的与组合。

func Contains 

func Contains[T comparable](v T) *Filter[T]

Contains 构造包含指定值的过滤条件。

func Eq 

func Eq[T comparable](v T) *Filter[T]

Eq 构造等于指定值的过滤条件。

func Gt 

func Gt[T comparable](v T) *Filter[T]

Gt 构造大于指定值的过滤条件。

func Gte 

func Gte[T comparable](v T) *Filter[T]

Gte 构造大于等于指定值的过滤条件。

func In 

func In[T comparable](values ...T) *Filter[T]

In 构造值属于给定集合的过滤条件。

func InSeq 

func InSeq[T comparable](values iter.Seq[T]) *Filter[T]

InSeq 构造值属于给定序列的过滤条件。

func Intersection 

func Intersection[T comparable](filters ...TypedRule[T]) *Filter[T]

Intersection 构造多个条件的交集组合。

func Lt 

func Lt[T comparable](v T) *Filter[T]

Lt 构造小于指定值的过滤条件。

func Lte 

func Lte[T comparable](v T) *Filter[T]

Lte 构造小于等于指定值的过滤条件。

func Neq 

func Neq[T comparable](v T) *Filter[T]

Neq 构造不等于指定值的过滤条件。

func Notin 

func Notin[T comparable](values ...T) *Filter[T]

Notin 构造值不属于给定集合的过滤条件。

func NotinSeq 

func NotinSeq[T comparable](values iter.Seq[T]) *Filter[T]

NotinSeq 构造值不属于给定序列的过滤条件。

func Or 

func Or[T comparable](filters ...TypedRule[T]) *Filter[T]

Or 构造多个条件的或组合。

func Prefix 

func Prefix[T comparable](v T) *Filter[T]

Prefix 构造前缀匹配的过滤条件。

func Suffix 

func Suffix[T comparable](v T) *Filter[T]

Suffix 构造后缀匹配的过滤条件。

func (Filter[T]) Args 

func (v Filter[T]) Args() iter.Seq[Arg]

func (Filter[T]) IsZero 

func (f Filter[T]) IsZero() bool

func (Filter[T]) MarshalDirective 

func (f Filter[T]) MarshalDirective() ([]byte, error)

func (Filter[T]) MarshalText 

func (f Filter[T]) MarshalText() ([]byte, error)

func (Filter[T]) New 

func (v Filter[T]) New() *T

func (Filter[T]) OneOf 

func (Filter[T]) OneOf() []any

func (Filter[T]) Op 

func (f Filter[T]) Op() Op

func (Filter[T]) String 

func (f Filter[T]) String() string

func (*Filter[T]) UnmarshalDirective 

func (f *Filter[T]) UnmarshalDirective(dec *directive.Decoder) error

func (*Filter[T]) UnmarshalText 

func (f *Filter[T]) UnmarshalText(data []byte) error

func (Filter[T]) WhereOf 

func (f Filter[T]) WhereOf(name string) Rule

type Op 

type Op uint8

+gengo:enum Op 表示过滤条件的操作符类型。 

const (
	OP_UNKNOWN Op = iota

	OP__EQ
	OP__NEQ
	OP__IN
	OP__NOTIN

	OP__GTE
	OP__GT
	OP__LTE
	OP__LT

	OP__NOTCONTAINS
	OP__CONTAINS
	OP__PREFIX
	OP__SUFFIX

	OP__WHERE
	OP__AND
	OP__OR

	OP__INTERSECTION
)

func ParseOpFromString 

func ParseOpFromString(s string) (Op, error)

func ParseOpLabelString 

func ParseOpLabelString(label string) (Op, error)

func (Op) EnumValues 

func (Op) EnumValues() []any

func (Op) IsZero 

func (v Op) IsZero() bool

func (Op) Label 

func (v Op) Label() string

func (Op) MarshalText 

func (v Op) MarshalText() ([]byte, error)

func (*Op) RuntimeDoc 

func (*Op) RuntimeDoc(names ...string) ([]string, bool)

func (*Op) Scan 

func (v *Op) Scan(src any) error

func (Op) String 

func (v Op) String() string

func (*Op) UnmarshalText 

func (v *Op) UnmarshalText(data []byte) error

func (Op) Value 

func (v Op) Value() (driver.Value, error)

type P 

type P struct{}

P 用于承载包级文档生成入口。

type Rule 

type Rule interface {
	Arg
	Op() Op

	IsZero() bool
	Args() iter.Seq[Arg]

	directive.Unmarshaler
}

Rule 表示通用过滤规则。

func OrRules 

func OrRules(rules ...Rule) Rule

OrRules 用 Rule 构造或组合过滤条件。

type RuleExpr 

type RuleExpr interface {
	IsZero() bool
	WhereOf(name string) Rule
}

RuleExpr 表示可按字段名展开为 Rule 的规则表达式。

type TypedRule 

type TypedRule[T comparable] interface {
	Rule

	New() *T
}

TypedRule 表示带值类型信息的过滤规则。

func Where 

func Where[T comparable](name string, rules ...TypedRule[T]) TypedRule[T]

Where 按字段名和规则构造 where 过滤条件。

type Value 

type Value[T comparable] interface {
	Arg
	Value() T
}

Value 表示持有具体值的过滤参数。

func Lit 

func Lit[T comparable](v T) Value[T]

Lit 把普通值包装为过滤字面量。

Source Files

View all Source files

Directories

Path Synopsis
internal
directive
Package directive GENERATED BY gengo:runtimedoc DON'T EDIT THIS FILE
 Package directive GENERATED BY gengo:runtimedoc DON'T EDIT THIS FILE

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.