Documentation
¶
Index ¶
- Constants
- type BinEdit
- type CmdEdit
- type Edit
- type ErrConnectionClosed
- type ErrDuplicateMacro
- type ErrEmptyCommand
- type ErrEmptyMacro
- type ErrEmptyRequest
- type ErrInvalidRepeatCommand
- type ErrInvalidTimeout
- type ErrTimeout
- type ErrUnknownCommand
- type ErrUnsupportedMessageType
- type ErrUnsupportedVersion
- type Exit
- type Factory
- type InputFileCommand
- type MacroRepo
- type MockMacroRepo
- type MockMacroRepo_Expecter
- type MockMacroRepo_Get_Call
- func (_c *MockMacroRepo_Get_Call) Return(_a0 core.Executer, _a1 error) *MockMacroRepo_Get_Call
- func (_c *MockMacroRepo_Get_Call) Run(run func(name string, argString string)) *MockMacroRepo_Get_Call
- func (_c *MockMacroRepo_Get_Call) RunAndReturn(run func(string, string) (core.Executer, error)) *MockMacroRepo_Get_Call
- type PingCommand
- type PrintMsg
- type RepeatCommand
- type Send
- type SendBinary
- type Sequence
- type SleepCommand
- type Templates
- type WaitForResp
Constants ¶
const ( PartsNumber = 2 LineUp = "\x1b[1A" LineClear = "\x1b[2K" HideCursor = "\x1b[?25l" ShowCursor = "\x1b[?25h" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BinEdit ¶ added in v0.10.0
type BinEdit struct{}
func NewBinEdit ¶ added in v0.10.0
func NewBinEdit() *BinEdit
NewBinEdit initializes and returns a new instance of BinEdit. It does not take any parameters. It returns a pointer to BinEdit, which can execute a binary edit command.
type CmdEdit ¶
type CmdEdit struct{}
func NewCmdEdit ¶
func NewCmdEdit() *CmdEdit
NewCmdEdit initializes and returns a new instance of CmdEdit. It does not take any parameters. It returns a pointer to CmdEdit, which can execute an edit command.
type Edit ¶
type Edit struct {
// contains filtered or unexported fields
}
type ErrConnectionClosed ¶
type ErrConnectionClosed struct{}
func (ErrConnectionClosed) Error ¶
func (e ErrConnectionClosed) Error() string
type ErrDuplicateMacro ¶
type ErrDuplicateMacro struct {
MacroName string
}
func (ErrDuplicateMacro) Error ¶
func (e ErrDuplicateMacro) Error() string
type ErrEmptyCommand ¶
type ErrEmptyCommand struct{}
func (ErrEmptyCommand) Error ¶
func (e ErrEmptyCommand) Error() string
type ErrEmptyMacro ¶
type ErrEmptyMacro struct {
MacroName string
}
func (ErrEmptyMacro) Error ¶
func (e ErrEmptyMacro) Error() string
type ErrEmptyRequest ¶
type ErrEmptyRequest struct{}
func (ErrEmptyRequest) Error ¶
func (e ErrEmptyRequest) Error() string
type ErrInvalidRepeatCommand ¶
type ErrInvalidRepeatCommand struct{}
func (ErrInvalidRepeatCommand) Error ¶
func (e ErrInvalidRepeatCommand) Error() string
type ErrInvalidTimeout ¶
type ErrInvalidTimeout struct {
Timeout string
}
func (ErrInvalidTimeout) Error ¶
func (e ErrInvalidTimeout) Error() string
type ErrTimeout ¶
type ErrTimeout struct{}
func (ErrTimeout) Error ¶
func (e ErrTimeout) Error() string
type ErrUnknownCommand ¶
type ErrUnknownCommand struct {
Command string
}
func (ErrUnknownCommand) Error ¶
func (e ErrUnknownCommand) Error() string
type ErrUnsupportedMessageType ¶
type ErrUnsupportedMessageType struct {
MsgType string
}
func (ErrUnsupportedMessageType) Error ¶
func (e ErrUnsupportedMessageType) Error() string
type ErrUnsupportedVersion ¶
type ErrUnsupportedVersion struct {
Version string
}
func (ErrUnsupportedVersion) Error ¶
func (e ErrUnsupportedVersion) Error() string
type Exit ¶
type Exit struct{}
type InputFileCommand ¶
type InputFileCommand struct {
// contains filtered or unexported fields
}
func NewInputFileCommand ¶
func NewInputFileCommand(filePath string) *InputFileCommand
NewInputFileCommand creates a new InputFileCommand instance. It takes filePath of type string, which specifies the path to the input file. It returns a pointer to an InputFileCommand initialized with the given file path.
func (*InputFileCommand) Execute ¶
func (c *InputFileCommand) Execute(exCtx core.ExecutionContext) (core.Executer, error)
Execute executes the InputFileCommand and returns a core.Executer and an error. It reads the file and executes the commands in the file.
type MockMacroRepo ¶ added in v0.7.0
MockMacroRepo is an autogenerated mock type for the MacroRepo type
func NewMockMacroRepo ¶ added in v0.7.0
func NewMockMacroRepo(t interface {
mock.TestingT
Cleanup(func())
}) *MockMacroRepo
NewMockMacroRepo creates a new instance of MockMacroRepo. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.
func (*MockMacroRepo) EXPECT ¶ added in v0.7.0
func (_m *MockMacroRepo) EXPECT() *MockMacroRepo_Expecter
type MockMacroRepo_Expecter ¶ added in v0.7.0
type MockMacroRepo_Expecter struct {
// contains filtered or unexported fields
}
func (*MockMacroRepo_Expecter) Get ¶ added in v0.7.0
func (_e *MockMacroRepo_Expecter) Get(name interface{}, argString interface{}) *MockMacroRepo_Get_Call
Get is a helper method to define mock.On call
- name string
- argString string
type MockMacroRepo_Get_Call ¶ added in v0.7.0
MockMacroRepo_Get_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Get'
func (*MockMacroRepo_Get_Call) Return ¶ added in v0.7.0
func (_c *MockMacroRepo_Get_Call) Return(_a0 core.Executer, _a1 error) *MockMacroRepo_Get_Call
func (*MockMacroRepo_Get_Call) Run ¶ added in v0.7.0
func (_c *MockMacroRepo_Get_Call) Run(run func(name string, argString string)) *MockMacroRepo_Get_Call
func (*MockMacroRepo_Get_Call) RunAndReturn ¶ added in v0.7.0
func (_c *MockMacroRepo_Get_Call) RunAndReturn(run func(string, string) (core.Executer, error)) *MockMacroRepo_Get_Call
type PingCommand ¶ added in v0.7.3
type PingCommand struct{}
func NewPingCommand ¶ added in v0.7.3
func NewPingCommand() *PingCommand
NewPingCommand creates a new PingCommand instance. It takes no parameters and returns a pointer to a PingCommand.
func (*PingCommand) Execute ¶ added in v0.7.3
func (c *PingCommand) Execute(exCtx core.ExecutionContext) (core.Executer, error)
type PrintMsg ¶
type PrintMsg struct {
// contains filtered or unexported fields
}
func NewPrintMsg ¶
NewPrintMsg creates a new PrintMsg instance with the provided core.Message. It takes a msg parameter of type core.Message, representing the message to be printed. It returns a pointer to a PrintMsg struct initialized with the given message.
type RepeatCommand ¶
type RepeatCommand struct {
// contains filtered or unexported fields
}
func NewRepeatCommand ¶
func NewRepeatCommand(times int, subCommand core.Executer) *RepeatCommand
NewRepeatCommand creates a new RepeatCommand to execute a sub-command multiple times. It takes times of type int, which specifies the number of repetitions, and subCommand of type core.Executer to repeat. It returns a pointer to a RepeatCommand initialized with the given subCommand and times.
func (*RepeatCommand) Execute ¶
func (c *RepeatCommand) Execute(exCtx core.ExecutionContext) (core.Executer, error)
Execute executes the RepeatCommand and returns a core.Executer and an error. It executes the sub-command the specified number of times.
type Send ¶
type Send struct {
// contains filtered or unexported fields
}
type SendBinary ¶ added in v0.10.0
type SendBinary struct {
// contains filtered or unexported fields
}
func NewSendBinary ¶ added in v0.10.0
func NewSendBinary(request string) *SendBinary
NewSendBinary creates a new SendBinary command with the provided binary request data.
func (*SendBinary) Execute ¶ added in v0.10.0
func (c *SendBinary) Execute(exCtx core.ExecutionContext) (core.Executer, error)
Execute sends the binary request using the WebSocket connection and returns a PrintMsg to print the response message.
type Sequence ¶
type Sequence struct {
// contains filtered or unexported fields
}
func NewSequence ¶
NewSequence creates a new Sequence containing a list of sub-commands. It takes subCommands, a slice of core.Executer, which represents the commands to be executed in order. It returns a pointer to a Sequence that will execute the sub-commands sequentially.
type SleepCommand ¶
type SleepCommand struct {
// contains filtered or unexported fields
}
func NewSleepCommand ¶
func NewSleepCommand(duration time.Duration) *SleepCommand
NewSleepCommand creates a new SleepCommand that pauses execution for a specified duration. It takes a duration parameter of type time.Duration. It returns a pointer to a SleepCommand instance.
func (*SleepCommand) Execute ¶
func (c *SleepCommand) Execute(_ core.ExecutionContext) (core.Executer, error)
Execute executes the SleepCommand and returns a core.Executer and an error. It sleeps for the specified duration.
type Templates ¶ added in v0.7.1
type Templates struct {
// contains filtered or unexported fields
}
func NewMacro ¶
NewMacro creates a new Templates instance by parsing a list of string templates. It takes a parameter templates of type []string, representing raw string templates. It returns a pointer to a Templates instance populated with parsed templates. It returns an error if any of the provided templates fail to parse.
func (*Templates) GetExecuter ¶ added in v0.7.1
GetExecuter generates an Executer based on the provided arguments and the templates in the Templates list. It takes args of type []string, representing input arguments for template execution. It returns a core.Executer initialized with the evaluated templates or an error if template execution fails. It returns an error if a template execution fails or if command creation from the template output fails. If a single template is evaluated, it returns the respective command; otherwise, returns a sequence of commands.
type WaitForResp ¶
type WaitForResp struct {
// contains filtered or unexported fields
}
func NewWaitForResp ¶
func NewWaitForResp(timeout time.Duration) *WaitForResp
NewWaitForResp creates a new WaitForResp command with the specified timeout duration. It takes a single parameter timeout of type time.Duration, determining how long to wait for a response. It returns a pointer to a WaitForResp instance.
func (*WaitForResp) Execute ¶
func (c *WaitForResp) Execute(exCtx core.ExecutionContext) (core.Executer, error)
Execute executes the WaitForResp command and waits for a response from the WebSocket connection. If a timeout is set, it will return an error if no response is received within the specified time. If a response is received, it will return a new PrintMsg command with the received message. If the WebSocket connection is closed, it will return an error.
Source Files