scorewr

Documentation

Overview

Package scorewr provides a wrapper for RBLs that inserts scores into responses.

This package is a work in progress and makes no API stability promises.

Index

• Constants
• func Builder(defaultCfg Config) xlistd.BuildWrapperFn
• type Config
• type ScoreExpr
  • func (e ScoreExpr) Match(s string) bool
• type Wrapper
  • func New(list xlistd.List, score int, cfg Config) *Wrapper
  • func (w *Wrapper) Check(ctx context.Context, name string, resource xlist.Resource) (xlist.Response, error)
  • func (w *Wrapper) Class() string
  • func (w *Wrapper) ID() string
  • func (w *Wrapper) Ping() error
  • func (w *Wrapper) Resources(ctx context.Context) ([]xlist.Resource, error)

Constants

const WrapperClass = "score"

WrapperClass defines default class name of component builder.

Functions

func Builder

func Builder(defaultCfg Config) xlistd.BuildWrapperFn

Builder returns a builder function.

Types

type Config

type Config struct {
	Scores []ScoreExpr
}

Config options.

type ScoreExpr

type ScoreExpr struct {
	RegExp *regexp.Regexp
	Score  int
}

ScoreExpr defines score matching.

func (ScoreExpr) Match

func (e ScoreExpr) Match(s string) bool

Match returns true if matching.

type Wrapper

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

Wrapper implements an xlist.Checker wrapper for insert scores.

func New

func New(list xlistd.List, score int, cfg Config) *Wrapper

New returns a new Wrapper.

func (*Wrapper) Check

func (w *Wrapper) Check(ctx context.Context, name string, resource xlist.Resource) (xlist.Response, error)

Check implements xlist.Checker interface.

func (*Wrapper) Class

func (w *Wrapper) Class() string

Class implements xlistd.List interface.

func (*Wrapper) ID

func (w *Wrapper) ID() string

ID implements xlistd.List interface.

func (*Wrapper) Ping

func (w *Wrapper) Ping() error

Ping implements xlistd.List interface.

func (*Wrapper) Resources

func (w *Wrapper) Resources(ctx context.Context) ([]xlist.Resource, error)

Resources implements xlist.Checker interface.