Console

Documentation

Index

• Constants
• type CommandInfo
  • func NewCommandInfo(description string, fn ConsoleFunc, args []string) *CommandInfo
  • func (inf *CommandInfo) ParseArgs(args []string) (map[string]any, error)
• type Console
  • func NewConsole() *Console
  • func (c *Console) AddCommand(name string, info *CommandInfo)
  • func (c *Console) ParseArgs(args []string) (*ParsedCommand, error)
• type ConsoleFunc
• type ParsedCommand
  • func NewParsedCommand(command string, flagMap map[string]any, fn ConsoleFunc) *ParsedCommand
  • func (pc *ParsedCommand) Execute() (any, error)
  • func (pc *ParsedCommand) GetCommand() string

Constants

const (
	HelpOpcode string = "help"
)

Types

type CommandInfo

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

func NewCommandInfo

func NewCommandInfo(description string, fn ConsoleFunc, args []string) *CommandInfo

func (*CommandInfo) ParseArgs

func (inf *CommandInfo) ParseArgs(args []string) (map[string]any, error)

type Console

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

func NewConsole

func NewConsole() *Console

func (*Console) AddCommand

func (c *Console) AddCommand(name string, info *CommandInfo)

func (*Console) ParseArgs

func (c *Console) ParseArgs(args []string) (*ParsedCommand, error)

type ConsoleFunc

type ConsoleFunc func(flagMap map[string]any) (any, error)

type ParsedCommand

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

func NewParsedCommand

func NewParsedCommand(command string, flagMap map[string]any, fn ConsoleFunc) *ParsedCommand

func (*ParsedCommand) Execute

func (pc *ParsedCommand) Execute() (any, error)

Execute executes the command with the given flags.

Returns:

• error: An error if the command failed to execute.

func (*ParsedCommand) GetCommand

func (pc *ParsedCommand) GetCommand() string

GetCommand returns the name of the command.