command

README

cmd-grep

Documentation

Index

• Constants
• func Grep(pattern GrepPattern, opts ...any) gloo.Command[[]byte, []byte]
• type Error
  • func (e Error) Error() string
• type GrepPattern

Constants

const (
	GrepIgnoreCase   grepIgnoreCaseFlag = true
	GrepNoIgnoreCase grepIgnoreCaseFlag = false
)

const (
	GrepInvert   grepInvertFlag = true
	GrepNoInvert grepInvertFlag = false
)

const (
	GrepWholeLine   grepWholeLineFlag = true
	GrepNoWholeLine grepWholeLineFlag = false
)

const (
	GrepExtended   grepExtendedFlag = true
	GrepNoExtended grepExtendedFlag = false
)

const (
	GrepWord   grepWordFlag = true
	GrepNoWord grepWordFlag = false
)

const (
	GrepLineNumbers   grepLineNumbersFlag = true
	GrepNoLineNumbers grepLineNumbersFlag = false
)

const (
	GrepCount   grepCountFlag = true
	GrepNoCount grepCountFlag = false
)

Functions

func Grep

func Grep(pattern GrepPattern, opts ...any) gloo.Command[[]byte, []byte]

Grep returns a Command that filters lines matching pattern. pattern is a required positional argument; the remaining options select the match mode.

Flags:

• GrepIgnoreCase (-i): case-insensitive matching
• GrepInvert (-v): emit non-matching lines
• GrepWholeLine (-x): match only when the whole line equals the pattern
• GrepExtended (-E): interpret the pattern as an extended regular expression
• GrepWord (-w): match only at word boundaries
• GrepLineNumbers (-n): prefix each emitted line with its line number
• GrepCount (-c): emit the count of matching lines instead of the lines

Types

type Error

type Error string

Error is the sole error type the package emits, enabling errors.Is checks.

const ErrInvalidPattern Error = "invalid pattern"

ErrInvalidPattern wraps a regular expression that fails to compile (-E/-w).

func (Error) Error

func (e Error) Error() string

type GrepPattern

type GrepPattern string

GrepPattern is the pattern grep matches each line against: a literal substring by default, or a regular expression under -E/-w.