command

Documentation

Overview

Copyright © 2022 Joel D. Elkins <joel@elkins.co>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• type Command
  • func NewConditional(name string, ifPart func() bool, thenPart Command, elsePart Command) Command
  • func NewDebug(msg string) Command
  • func NewFunc(name string, f func() error) Command
  • func NewIndirect(c Command) Command
  • func NewNop() Command
  • func NewSet(cs CommandSet) Command
  • func NewShell(cmd string) Command
  • func (c Command) Execute(output io.Writer, fake bool, commandSetID string) error
• type CommandSet
  • func (cmds CommandSet) Execute(output io.Writer, fake bool) error
• type CommandType
  • func (ct CommandType) String() string
• type Commands

Types

type Command

type Command struct {
	Type    CommandType
	Command interface{}
}

func NewConditional

func NewConditional(name string, ifPart func() bool, thenPart Command, elsePart Command) Command

func NewDebug

func NewDebug(msg string) Command

func NewFunc

func NewFunc(name string, f func() error) Command

func NewIndirect

func NewIndirect(c Command) Command

func NewNop

func NewNop() Command

func NewSet

func NewSet(cs CommandSet) Command

func NewShell

func NewShell(cmd string) Command

func (Command) Execute

func (c Command) Execute(output io.Writer, fake bool, commandSetID string) error

type CommandSet

type CommandSet struct {
	ID string
	Commands
}

func (CommandSet) Execute

func (cmds CommandSet) Execute(output io.Writer, fake bool) error

type CommandType

type CommandType int

const (
	CT_NOP CommandType = iota
	CT_SHELL
	CT_FUNC
	CT_INDIRECT
	CT_SET
	CT_DEBUG
	CT_CONDITIONAL
)

func (CommandType) String

func (ct CommandType) String() string

type Commands

type Commands []Command