core

Mar 6, 2026

Changes in this version

+ func SanitizeMetricLabel(s string) string

type Bgpipe

+ HTTP *http.Server

+ StartTime time.Time

type Stage

+ RouteHTTP func(r chi.Router) error

type StageBase

+ HTTPPath string

+ func (s *StageBase) HTTPSlug() string

+ func (s *StageBase) MetricPrefix() string

+ func (s *StageBase) RouteHTTP(r chi.Router) error

Feb 10, 2026

Changes in this version

type StageOptions

+ StopTimeout time.Duration

Jan 15, 2026

Changes in this version

type StageBase

+ FilterIn []*filter.Filter

+ FilterOut []*filter.Filter

Nov 21, 2025

Changes in this version

+ func IsPath(v string, b *Bgpipe) bool

Oct 10, 2025

Changes in this version

+ var ErrPipeFinished = errors.New("pipe stopped")

type Bgpipe

+ Version string

Jun 13, 2025

Changes in this version

+ var ErrNoCallbacks = errors.New("stage has no callbacks registered")

+ var ErrNoInputs = errors.New("stage has no inputs registered")

type StageOptions

+ FilterIn bool

+ FilterOut bool

Oct 4, 2024

Changes in this version

+ const StyleBlack

+ const StyleBlue

+ const StyleBold

+ const StyleCyan

+ const StyleGreen

+ const StyleMagenta

+ const StyleNone

+ const StyleRed

+ const StyleReset

+ const StyleUnderline

+ const StyleWhite

+ const StyleYellow

+ func ParseEvents(src []string, stage_defaults ...string) []string

+ func ParseTypes(src []string, dst []msg.Type) ([]msg.Type, error)

type Bgpipe

+ func (b *Bgpipe) StageDump(d dir.Dir, w io.Writer) (total int)

type StageBase

+ Args []string

+ Flags []string

Apr 12, 2024

Changes in this version

type StageBase

+ IsBidir bool

Feb 19, 2024

Changes in this version

type Bgpipe

+ func (b *Bgpipe) AttachStages() error

type StageBase

+ func (s *StageBase) StringLR() string

Oct 30, 2023

Changes in this version

+ var ErrFirstOrLast = errors.New("must be either the first or the last stage")

+ var ErrInject = errors.New("invalid --in option value")

+ var ErrKill = errors.New("session killed by an event")

+ var ErrLR = errors.New("select either --left or --right, not both")

+ var ErrStageCmd = errors.New("invalid stage command")

+ var ErrStageDiff = errors.New("already defined but different")

+ var ErrStageStopped = errors.New("stage stopped")

+ func IsAddr(v string) bool

+ func IsBind(v string) bool

+ func IsFile(v string) bool

+ type Bgpipe struct

+ Cancel context.CancelCauseFunc

+ Ctx context.Context

+ F *pflag.FlagSet

+ K *koanf.Koanf

+ Pipe *pipe.Pipe

+ Stages []*StageBase

+ func NewBgpipe(repo ...map[string]NewStage) *Bgpipe

+ func (b *Bgpipe) AddRepo(cmds map[string]NewStage)

+ func (b *Bgpipe) AddStage(idx int, cmd string) (*StageBase, error)

+ func (b *Bgpipe) Attach() error

+ func (b *Bgpipe) Configure() error

+ func (b *Bgpipe) KillEvent(ev *pipe.Event) bool

+ func (b *Bgpipe) LogEvent(ev *pipe.Event) bool

+ func (b *Bgpipe) NewStage(cmd string) *StageBase

+ func (b *Bgpipe) Run() error

+ func (b *Bgpipe) StageCount() int

+ func (b *Bgpipe) Start(ev *pipe.Event) bool

+ type NewStage func(base *StageBase) Stage

+ type Stage interface

+ Attach func() error

+ Prepare func() error

+ Run func() error

+ Stop func() error

+ type StageBase struct

+ B *Bgpipe

+ Cancel context.CancelCauseFunc

+ Cmd string

+ Ctx context.Context

+ Dir msg.Dir

+ Downstream *pipe.Line

+ Index int

+ IsFirst bool

+ IsLast bool

+ IsLeft bool

+ IsRight bool

+ K *koanf.Koanf

+ Name string

+ Options StageOptions

+ P *pipe.Pipe

+ Upstream *pipe.Line

+ func (s *StageBase) Attach() error

+ func (s *StageBase) Errorf(format string, a ...any) error

+ func (s *StageBase) Event(et string, args ...any) *pipe.Event

+ func (s *StageBase) Prepare() error

+ func (s *StageBase) Run() error

+ func (s *StageBase) Running() bool

+ func (s *StageBase) Stop() error

+ func (s *StageBase) String() string

+ type StageOptions struct

+ Args []string

+ Bidir bool

+ Descr string

+ Events map[string]string

+ Flags *pflag.FlagSet

+ IsConsumer bool

+ IsProducer bool

+ IsStdin bool

+ IsStdout bool

+ Usage string