runcmdopt

Documentation

Index

• type Option
  • func ReadPreference(rp *readpref.ReadPref) Option
• type RunCmd
• type RunCmdBundle
  • func BundleRunCmd(opts ...Option) *RunCmdBundle
  • func (rcb *RunCmdBundle) ReadPreference(rp *readpref.ReadPref) *RunCmdBundle
  • func (rcb *RunCmdBundle) String() string
  • func (rcb *RunCmdBundle) Unbundle() (*RunCmd, error)

Types

type Option

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

Option represents a RunCommand option.

func ReadPreference

func ReadPreference(rp *readpref.ReadPref) Option

ReadPreference sets the read preference.

type RunCmd

type RunCmd struct {
	ReadPreference *readpref.ReadPref
}

RunCmd represents a run command.

type RunCmdBundle

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

RunCmdBundle is a bundle of RunCommand options.

func BundleRunCmd

func BundleRunCmd(opts ...Option) *RunCmdBundle

BundleRunCmd bundles RunCommand options

func (*RunCmdBundle) ReadPreference

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

ReadPreference sets the read preference.

func (*RunCmdBundle) String

func (rcb *RunCmdBundle) String() string

String implements the Stringer interface

func (*RunCmdBundle) Unbundle

func (rcb *RunCmdBundle) Unbundle() (*RunCmd, error)

Unbundle unbundles the options, returning a RunCmd instance.