client

Documentation

Index

• Variables
• func ApplyOptions(rc Runner, opts ...RunnerOption) error
• type LocalRunner
  • func NewLocalRunner(opts ...RunnerOption) (*LocalRunner, error)
  • func (r *LocalRunner) Cleanup(ctx context.Context) error
  • func (r *LocalRunner) DryRunBlock(ctx context.Context, block *document.CodeBlock, w io.Writer, ...) error
  • func (r *LocalRunner) RunBlock(ctx context.Context, block *document.CodeBlock) error
• type RemoteRunner
  • func NewRemoteRunner(ctx context.Context, addr string, opts ...RunnerOption) (*RemoteRunner, error)
  • func (r *RemoteRunner) Cleanup(ctx context.Context) error
  • func (r *RemoteRunner) DryRunBlock(ctx context.Context, block *document.CodeBlock, w io.Writer, ...) error
  • func (r *RemoteRunner) RunBlock(ctx context.Context, block *document.CodeBlock) error
• type Runner
• type RunnerOption
  • func WithDir(dir string) RunnerOption
  • func WithLogger(logger *zap.Logger) RunnerOption
  • func WithSession(s *runner.Session) RunnerOption
  • func WithStderr(stderr io.Writer) RunnerOption
  • func WithStdin(stdin io.Reader) RunnerOption
  • func WithStdout(stdout io.Writer) RunnerOption
  • func WithinShellMaybe() RunnerOption

Variables

var ErrRunnerClientUnimplemented = fmt.Errorf("method unimplemented")

Functions

func ApplyOptions

func ApplyOptions(rc Runner, opts ...RunnerOption) error

Types

type LocalRunner

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

func NewLocalRunner

func NewLocalRunner(opts ...RunnerOption) (*LocalRunner, error)

func (*LocalRunner) Cleanup

func (r *LocalRunner) Cleanup(ctx context.Context) error

func (*LocalRunner) DryRunBlock

func (r *LocalRunner) DryRunBlock(ctx context.Context, block *document.CodeBlock, w io.Writer, opts ...RunnerOption) error

func (*LocalRunner) RunBlock

func (r *LocalRunner) RunBlock(ctx context.Context, block *document.CodeBlock) error

type RemoteRunner

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

func NewRemoteRunner

func NewRemoteRunner(ctx context.Context, addr string, opts ...RunnerOption) (*RemoteRunner, error)

func (*RemoteRunner) Cleanup

func (r *RemoteRunner) Cleanup(ctx context.Context) error

func (*RemoteRunner) DryRunBlock

func (r *RemoteRunner) DryRunBlock(ctx context.Context, block *document.CodeBlock, w io.Writer, opts ...RunnerOption) error

func (*RemoteRunner) RunBlock

func (r *RemoteRunner) RunBlock(ctx context.Context, block *document.CodeBlock) error

type Runner

type Runner interface {
	RunBlock(ctx context.Context, block *document.CodeBlock) error
	DryRunBlock(ctx context.Context, block *document.CodeBlock, w io.Writer, opts ...RunnerOption) error
	Cleanup(ctx context.Context) error
	// contains filtered or unexported methods
}

type RunnerOption

type RunnerOption func(Runner) error

func WithDir

func WithDir(dir string) RunnerOption

func WithLogger

func WithLogger(logger *zap.Logger) RunnerOption

func WithSession

func WithSession(s *runner.Session) RunnerOption

func WithStderr

func WithStderr(stderr io.Writer) RunnerOption

func WithStdin

func WithStdin(stdin io.Reader) RunnerOption

func WithStdout

func WithStdout(stdout io.Writer) RunnerOption

func WithinShellMaybe

func WithinShellMaybe() RunnerOption