filter

Documentation

Index

• type Filter
  • func NewFilter(config config, ruleMatcher ruleMatcher, exceptionRuleMatcher ruleMatcher, ...) (*Filter, error)
  • func (f *Filter) AddRules(reader io.Reader, filterName *string) (ruleCount, exceptionCount int)
  • func (f *Filter) HandleRequest(req *http.Request) *http.Response

Types

type Filter

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

Filter is a filter for URLs that is capable of Adblock-style filter lists and hosts rules and matching URLs against them.

The filter is safe for concurrent use.

func NewFilter

func NewFilter(config config, ruleMatcher ruleMatcher, exceptionRuleMatcher ruleMatcher, eventsEmitter filterEventsEmitter) (*Filter, error)

NewFilter creates and initializes a new filter.

func (*Filter) AddRules

func (f *Filter) AddRules(reader io.Reader, filterName *string) (ruleCount, exceptionCount int)

AddRules parses the rules from the given reader and adds them to the filter.

func (*Filter) HandleRequest

func (f *Filter) HandleRequest(req *http.Request) *http.Response

HandleRequest handles the given request by matching it against the filter rules. If the request should be blocked, it returns a response that blocks the request. If the request should be modified, it modifies it in-place.