filters

Documentation

Overview

Package filters implements text filtering.

Index

• func Register(name string, maker Maker)
• type CSSMin
  • func (f CSSMin) Apply(in []byte) (out []byte, err error)
  • func (f CSSMin) Name() string
• type Collection
  • func NewCollection() *Collection
  • func (c *Collection) Add(key string, filterName string, args []string) error
  • func (c *Collection) AddFromYAML(key string, line interface{}) error
  • func (c *Collection) ApplyFilter(key string, in []byte) (out []byte, err error)
  • func (c *Collection) Get(key string) Filter
  • func (c *Collection) SetEnabled(enabled bool)
• type Exec
  • func (f *Exec) Apply(in []byte) (out []byte, err error)
  • func (f *Exec) Name() string
• type Filter
  • func Make(name string, args []string) Filter
• type HTMLMin
  • func (f *HTMLMin) Apply(in []byte) (out []byte, err error)
  • func (f *HTMLMin) Name() string
• type JSMin
  • func (f JSMin) Apply(in []byte) (out []byte, err error)
  • func (f JSMin) Name() string
• type Maker

Functions

func Register

func Register(name string, maker Maker)

Register registers a new filter maker.

Types

type CSSMin

type CSSMin int

func (CSSMin) Apply

func (f CSSMin) Apply(in []byte) (out []byte, err error)

func (CSSMin) Name

func (f CSSMin) Name() string

type Collection

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

Collection is a collection of filters addressed by some key.

func NewCollection

func NewCollection() *Collection

NewCollection returns a new collection.

func (*Collection) Add

func (c *Collection) Add(key string, filterName string, args []string) error

Add adds the filter to collection to be addressable by key.

func (*Collection) AddFromYAML

func (c *Collection) AddFromYAML(key string, line interface{}) error

AddFromYAML parses a `filters` value (line) and adds corresponding filters.

func (*Collection) ApplyFilter

func (c *Collection) ApplyFilter(key string, in []byte) (out []byte, err error)

ApplyFilter applies a filter found by key to the given string. If the filter wasn't found, returns the original string.

func (*Collection) Get

func (c *Collection) Get(key string) Filter

Get returns a filter for key. It returns nil if the filter wasn't found.

func (*Collection) SetEnabled

func (c *Collection) SetEnabled(enabled bool)

SetEnabled sets enabled state of the collection.

type Exec

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

func (*Exec) Apply

func (f *Exec) Apply(in []byte) (out []byte, err error)

func (*Exec) Name

func (f *Exec) Name() string

type Filter

type Filter interface {
	Name() string
	Apply([]byte) ([]byte, error)
}

Filter is an interface declaring a filter.

func Make

func Make(name string, args []string) Filter

Make creates a new filter by name with the given arguments. It returns nil if it can't find a filter maker with such name.

type HTMLMin

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

func (*HTMLMin) Apply

func (f *HTMLMin) Apply(in []byte) (out []byte, err error)

func (*HTMLMin) Name

func (f *HTMLMin) Name() string

type JSMin

type JSMin int

func (JSMin) Apply

func (f JSMin) Apply(in []byte) (out []byte, err error)

func (JSMin) Name

func (f JSMin) Name() string

type Maker

type Maker func([]string) Filter

Maker is a type of function which accepts arguments for filter and returns a new instance of the filter.