runcmdopt

package

v0.0.14 Latest Latest Go to latest Published: Sep 20, 2018 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Option interface {
	// contains filtered or unexported methods
}

Option represents a RunCommand option.

func ReadPreference(rp *readpref.ReadPref) Option

ReadPreference sets the read preference.

type RunCmd struct {
	ReadPreference *readpref.ReadPref
}

RunCmd represents a run command.

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

RunCmdBundle is a bundle of RunCommand options.

func BundleRunCmd(opts ...Option) *RunCmdBundle

BundleRunCmd bundles RunCommand options

func (rcb *RunCmdBundle) ReadPreference(rp *readpref.ReadPref) *RunCmdBundle

ReadPreference sets the read preference.

func (rcb *RunCmdBundle) String() string

String implements the Stringer interface

func (rcb *RunCmdBundle) Unbundle() (*RunCmd, *session.Client, error)

Unbundle unbundles the options, returning a RunCmd instance.

type RunCmdSession interface {
	Option
	ConvertRunCmdSession() *session.Client
}

RunCmdSession is the session for the runCommand() function

type RunCmdSessionOpt struct{}

RunCmdSessionOpt is a RunCommand session option.

func (RunCmdSessionOpt) ConvertRunCmdSession() *session.Client

ConvertRunCmdSession implements the RunCmdSession interface.