util

Documentation

Index

• Constants
• type IOStreams
• type Options
  • func NewFakeOpts(out io.Writer, objs ...runtime.Object) (*Options, error)
  • func NewOpts(out, errout io.Writer, in io.Reader) (*Options, error)

Constants

const (
	// HandshakeString is the string that the runner expects to receive via stdin prior to running.
	HandshakeString = "opensesame"
)

TODO: move constants somewhere more appropriate

Types

type IOStreams

type IOStreams struct {
	// In think, os.Stdin
	In io.Reader
	// Out think, os.Stdout
	Out io.Writer
	// ErrOut think, os.Stderr
	ErrOut io.Writer
}

IOStreams provides the standard names for iostreams. This is useful for embedding and for unit testing. Inconsistent and different names make it hard to read and review code

type Options

type Options struct {
	// Deferred creation of clients
	client.ClientCreator

	// Function to attach to a pod's TTY
	attacher.AttachFunc

	// Function to get a pod's logs stream
	logstreamer.GetLogsFunc

	IOStreams

	Debug bool
}

Options pertaining to stok apps

func NewFakeOpts

func NewFakeOpts(out io.Writer, objs ...runtime.Object) (*Options, error)

func NewOpts

func NewOpts(out, errout io.Writer, in io.Reader) (*Options, error)