filter

package

v3.4.0 Latest Latest Go to latest Published: Sep 23, 2023 License: GPL-3.0 Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ncarlier/feedpushr

Links

Open Source Insights

Documentation ¶

Index ¶

func NewFilterResponseFromDef(def *model.FilterDef) *app.FilterResponse
type Builder
- func NewBuilder() *Builder
type Chain
- func NewChainFilter(definitions model.FilterDefCollection) (*Chain, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewFilterResponseFromDef ¶ added in v3.4.0

func NewFilterResponseFromDef(def *model.FilterDef) *app.FilterResponse

NewFilterResponseFromDef creates new Filter response from a definition

Types ¶

type Builder ¶ added in v3.4.0

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

Builder is used to create an Filter definition

func NewBuilder ¶ added in v3.4.0

func NewBuilder() *Builder

NewBuilder creates new Filter definition builder instance

func (*Builder) Alias ¶ added in v3.4.0

func (fb *Builder) Alias(alias *string) *Builder

Alias set alias

func (*Builder) Build ¶ added in v3.4.0

func (fb *Builder) Build() *model.FilterDef

Build creates the filter definition

func (*Builder) Condition ¶ added in v3.4.0

func (fb *Builder) Condition(condition *string) *Builder

Condition set condition

func (*Builder) Enable ¶ added in v3.4.0

func (fb *Builder) Enable(status bool) *Builder

Enable set enabled status

func (*Builder) From ¶ added in v3.4.0

func (fb *Builder) From(source model.FilterDef) *Builder

From creates filter form an other

func (*Builder) FromURI ¶ added in v3.4.0

func (fb *Builder) FromURI(URI string) *Builder

FromURI creates a filter definition form an URI

func (*Builder) ID ¶ added in v3.4.0

func (fb *Builder) ID(ID string) *Builder

ID set ID

func (*Builder) NewID ¶ added in v3.4.0

func (fb *Builder) NewID() *Builder

NewID set new ID

func (*Builder) Props ¶ added in v3.4.0

func (fb *Builder) Props(props model.FilterProps) *Builder

Props set props

func (*Builder) Spec ¶ added in v3.4.0

func (fb *Builder) Spec(name string) *Builder

Spec set spec name

type Chain ¶

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

Chain contains filter chain

func NewChainFilter ¶

func NewChainFilter(definitions model.FilterDefCollection) (*Chain, error)

NewChainFilter create new chain filter

func (*Chain) Add ¶

func (chain *Chain) Add(def *model.FilterDef) (model.Filter, error)

Add a filter to the chain

func (*Chain) Apply ¶

func (chain *Chain) Apply(article *model.Article) error

Apply applies filter chain on an article

func (*Chain) Get ¶

func (chain *Chain) Get(id string) (model.Filter, error)

Get returns a filter of the chain filter

func (*Chain) GetAvailableFilters ¶

func (chain *Chain) GetAvailableFilters() []model.Spec

GetAvailableFilters get all available filters

func (*Chain) GetFilterDefs ¶

func (chain *Chain) GetFilterDefs() model.FilterDefCollection

GetFilterDefs return definitions of the chain filter

func (*Chain) Remove ¶

func (chain *Chain) Remove(id string) error

Remove a filter from the chain

func (*Chain) Update ¶

func (chain *Chain) Update(id string, update *model.FilterDef) (model.Filter, error)

Update a filter of the chain

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
plugins

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL