with

README

with - Pattern Extractor

The with middleware parses the pipe's input using a regular expression and passes each match to a specified handler.

Documentation

Overview

Package with provides a middleware that extracts and processes input patterns

Index

• type Middleware
  • func NewMiddleware() Middleware
  • func (withMiddleware Middleware) Apply(run *pipeline.Run, next func(*pipeline.Run), ...)
  • func (withMiddleware Middleware) String() string

Types

type Middleware

type Middleware struct {
}

Middleware is a pattern extractor

func NewMiddleware

func NewMiddleware() Middleware

NewMiddleware creates a new middleware instance

func (Middleware) Apply

func (withMiddleware Middleware) Apply(
	run *pipeline.Run,
	next func(*pipeline.Run),
	executionContext *middleware.ExecutionContext,
)

Apply is where the middleware's logic resides

It adapts the run based on its slice of the run's arguments. It may also trigger side effects such as executing shell commands or full runs of other pipelines. When done, this function should call next in order to continue unwinding the stack.

func (Middleware) String

func (withMiddleware Middleware) String() string

String is a human-readable description