filter

Documentation

Index

• Variables
• type Filter
  • func (f *Filter) MarshalJSON() ([]byte, error)
  • func (f *Filter) UnmarshalJSON(b []byte) error
• type Filterer
• type JMESPath
  • func (j *JMESPath) Run(bdy []byte) (out interface{}, err error)
  • func (j *JMESPath) StripUnsafe() error
• type Xidel

Variables

var (
	// Runner lets us mock exec.Command for testing
	Runner = exec.Command
	// ErrUnknownFilter indicates the type of filter is not recognized
	ErrUnknownFilter = fmt.Errorf("unknown filter type")
)

Types

type Filter

type Filter struct {
	Type     string `json:"type"`
	Filterer `json:"-"`
}

Filter is an individual filter

func (*Filter) MarshalJSON

func (f *Filter) MarshalJSON() ([]byte, error)

MarshalJSON encodes our Filterer as `filter`

func (*Filter) UnmarshalJSON

func (f *Filter) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals our Filterer interface to a struct

type Filterer

type Filterer interface {
	StripUnsafe() error
	Run(bdy []byte) (out interface{}, err error)
}

Filterer outlines methods to filter data

type JMESPath

type JMESPath struct {
	Expression string `json:"expression"`
}

JMESPath is a JMESPath filter

func (*JMESPath) Run

func (j *JMESPath) Run(bdy []byte) (out interface{}, err error)

Run applies a JMESPath filter

func (*JMESPath) StripUnsafe

func (j *JMESPath) StripUnsafe() error

StripUnsafe removes unsafe characters to prevent cli injection

type Xidel

type Xidel struct {
	Expression string `json:"expression"`
}

Xidel is a filter that is used by XPath