filter

Documentation

Overview

Package filter provides fundamentals for each filters.

Index

• func MustRegister(name string, f Factory)
• func Register(name string, f Factory) error
• type Base
  • func (b *Base) Close() error
  • func (b *Base) Init(r io.ReadCloser, readNext BaseReadNext)
  • func (b *Base) Read(buf []byte) (int, error)
  • func (b *Base) ReadLine() ([]byte, error)
• type BaseReadNext
• type Factory
  • func Find(name string) Factory
• type Grep
  • func NewGrep(r io.ReadCloser, re *regexp.Regexp, match bool, lf LineFilter, lnum bool, ...) *Grep
• type Hash
  • func NewHash(r io.ReadCloser, h hash.Hash, enc hashEncoder) *Hash
• type Head
  • func NewHead(r io.ReadCloser, start, limit uint) *Head
• type LTSV
  • func NewLTSV(r io.ReadCloser, label string, re *regexp.Regexp, match bool, cut []string) *LTSV
• type LineFilter
  • func NewCutLF(sep []byte, n int) LineFilter
  • func (lf LineFilter) Apply(b []byte) []byte
  • func (lf LineFilter) Chain(second LineFilter) LineFilter
• type Params
  • func (p Params) Bool(n string, value bool) bool
  • func (p Params) Int(n string, value int) int
  • func (p Params) String(n string, value string) string

Functions

func MustRegister

func MustRegister(name string, f Factory)

MustRegister registers a filter, panic if failed.

func Register

func Register(name string, f Factory) error

Register registers a filter with name.

Types

type Base

type Base struct {
	Reader *bufio.Reader
	// contains filtered or unexported fields
}

Base is base of filters. It provides common features for filter.

func (*Base) Close

func (b *Base) Close() error

Close closes head filter.

func (*Base) Init

func (b *Base) Init(r io.ReadCloser, readNext BaseReadNext)

Init initializes Base object.

func (*Base) Read

func (b *Base) Read(buf []byte) (int, error)

func (*Base) ReadLine

func (b *Base) ReadLine() ([]byte, error)

ReadLine reads a line as []byte.

type BaseReadNext

type BaseReadNext func(buf *bytes.Buffer) error

BaseReadNext is callback to read next data hunk to buf

type Factory

type Factory func(*resource.Resource, Params) (*resource.Resource, error)

Factory is filter factory.

func Find

func Find(name string) Factory

Find finds a filter.

type Grep

type Grep struct {
	Base
	// contains filtered or unexported fields
}

Grep represents grep like filter.

func NewGrep

func NewGrep(r io.ReadCloser, re *regexp.Regexp, match bool, lf LineFilter, lnum bool, cnum int) *Grep

NewGrep creates an instance of grep filter.

type Hash

type Hash struct {
	Base
	// contains filtered or unexported fields
}

Hash represents hash filter.

func NewHash

func NewHash(r io.ReadCloser, h hash.Hash, enc hashEncoder) *Hash

NewHash creates a hash filter instance.

type Head

type Head struct {
	Base
	// contains filtered or unexported fields
}

Head is "head" like filter.

func NewHead

func NewHead(r io.ReadCloser, start, limit uint) *Head

NewHead creates an instance of head filter.

type LTSV

type LTSV struct {
	Base
	// contains filtered or unexported fields
}

LTSV represents a structure for LTSV (labeled tab separated value)

func NewLTSV

func NewLTSV(r io.ReadCloser, label string, re *regexp.Regexp, match bool, cut []string) *LTSV

NewLTSV creates a new instance of LTSV.

type LineFilter

type LineFilter func([]byte) []byte

LineFilter is a line filter.

var TrimEOL LineFilter = func(b []byte) []byte {
	l := len(b)
	if l >= 1 && b[l-1] == '\n' {
		c := 1
		if l >= 2 && b[len(b)-2] == '\r' {
			c++
		}
		return b[:len(b)-c]
	}
	return b
}

TrimEOL trims EOL bytes.

func NewCutLF

func NewCutLF(sep []byte, n int) LineFilter

NewCutLF creates a cut line filter with sep and position.

func (LineFilter) Apply

func (lf LineFilter) Apply(b []byte) []byte

Apply applies a filter to a line bytes.

func (LineFilter) Chain

func (lf LineFilter) Chain(second LineFilter) LineFilter

Chain createa a new LineFilters which chains two LineFilters.

type Params

type Params map[string]string

Params represents parameters for filter.

func (Params) Bool

func (p Params) Bool(n string, value bool) bool

Bool gets bool value from Params by name.

func (Params) Int

func (p Params) Int(n string, value int) int

Int gets int value from Params by name.

func (Params) String

func (p Params) String(n string, value string) string

String gets string value from Params by name.