filters

Documentation

Overview

Package filters contains Beehive's filter system.

Index

• func RegisterFilter(filter FilterInterface)
• type FilterInterface
  • func GetFilter(identifier string) *FilterInterface

Functions

func RegisterFilter

func RegisterFilter(filter FilterInterface)

RegisterFilter gets called by Filters to register themselves.

Types

type FilterInterface

type FilterInterface interface {
	// Name of the filter
	Name() string
	// Description of the filter
	Description() string

	// Execute the filter
	Passes(data interface{}, value interface{}) bool
}

FilterInterface is an interface all Filters implement.

func GetFilter

func GetFilter(identifier string) *FilterInterface

GetFilter returns a filter with a specific name