command.go

package gonsole

import (
	"github.com/lixianmin/gonsole/road"
	"github.com/lixianmin/got/loom"
)

/********************************************************************
created:    2020-06-04
author:     lixianmin

Copyright (C) - All Rights Reserved
*********************************************************************/

type Command struct {
	loom.Flag                                                             // command的flag
	Name      string                                                      // 名称
	Example   string                                                      // 示例
	Note      string                                                      // 描述
	Handler   func(client road.Session, args []string) (*Response, error) // 处理方法
}

func (cmd *Command) GetName() string {
	return cmd.Name
}

func (cmd *Command) GetExample() string {
	return cmd.Example
}

func (cmd *Command) GetNote() string {
	return cmd.Note
}

func (cmd *Command) IsBuiltin() bool {
	return cmd.HasFlag(flagBuiltin)
}

func (cmd *Command) IsPublic() bool {
	return cmd.HasFlag(FlagPublic)
}

func (cmd *Command) IsInvisible() bool {
	return cmd.HasFlag(FlagInvisible)
}

func (cmd *Command) Run(session road.Session, args []string) (*Response, error) {
	return cmd.Handler(session, args)
}