mpipe

README

Small wrapper around os/exec package to offer some qol improvements for piping commands with custom behaviour

---

Documentation

Index

• type Mpipe
  • func Command(name string, args ...string) *Mpipe
  • func CommandContext(ctx context.Context, name string, args ...string) *Mpipe
  • func CommandContextWithOptions(ctx context.Context, opts []MpipeOptions, name string, args ...string) *Mpipe
  • func CommandWithOptions(opts []MpipeOptions, name string, args ...string) *Mpipe
  • func (m *Mpipe) Run() error
  • func (m *Mpipe) Start() error
  • func (m *Mpipe) String() string
  • func (m *Mpipe) Wait() error
• type MpipeOptions
  • func WithStderrTransformer(t Transformer) MpipeOptions
  • func WithStdinTransformer(t Transformer) MpipeOptions
  • func WithStdoutTransformer(t Transformer) MpipeOptions
• type Transformer

Types

type Mpipe

type Mpipe struct {
	// contains filtered or unexported fields
}

func Command

func Command(name string, args ...string) *Mpipe

func CommandContext

func CommandContext(ctx context.Context, name string, args ...string) *Mpipe

func CommandContextWithOptions

func CommandContextWithOptions(ctx context.Context, opts []MpipeOptions, name string, args ...string) *Mpipe

func CommandWithOptions

func CommandWithOptions(opts []MpipeOptions, name string, args ...string) *Mpipe

func (*Mpipe) Run

func (m *Mpipe) Run() error

func (*Mpipe) Start

func (m *Mpipe) Start() error

func (*Mpipe) String

func (m *Mpipe) String() string

func (*Mpipe) Wait

func (m *Mpipe) Wait() error

type MpipeOptions

type MpipeOptions func(*Mpipe)

func WithStderrTransformer

func WithStderrTransformer(t Transformer) MpipeOptions

func WithStdinTransformer

func WithStdinTransformer(t Transformer) MpipeOptions

func WithStdoutTransformer

func WithStdoutTransformer(t Transformer) MpipeOptions

type Transformer

type Transformer func(string) string

var NoTransform Transformer = func(s string) string {
	return s
}