about

package

v1.2.0 Latest Latest Go to latest Published: Apr 9, 2019 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/brada954/restshell

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func AddCommands()
type AboutCommand
- func NewAboutCommand() *AboutCommand
- func (cmd *AboutCommand) AddOptions(set shell.CmdSet)
- func (cmd *AboutCommand) Execute(args []string) error
type AuthTopic
- func NewAuthTopic() *AuthTopic
type BenchmarkTopic
- func NewBenchmarkTopic() *BenchmarkTopic
type SubTopicInterface
type SubstitutionTopic
- func NewSubstitutionTopic() *SubstitutionTopic
type TopicInterface
type VersionCommand
- func NewVersionCommand() *VersionCommand
- func (cmd *VersionCommand) AddOptions(set shell.CmdSet)
- func (cmd *VersionCommand) Execute(args []string) error

Constants ¶

This section is empty.

Variables ¶

View Source

var BuildBranch string

View Source

var BuildCommit string

View Source

var BuildVersion string

Functions ¶

func AddCommands ¶

func AddCommands()

Types ¶

type AboutCommand ¶

type AboutCommand struct {
}

func NewAboutCommand ¶

func NewAboutCommand() *AboutCommand

func (*AboutCommand) AddOptions ¶

func (cmd *AboutCommand) AddOptions(set shell.CmdSet)

func (*AboutCommand) Execute ¶

func (cmd *AboutCommand) Execute(args []string) error

Execute --

type AuthTopic ¶

type AuthTopic struct {
	Key         string
	Title       string
	Description string
	About       string
}

func NewAuthTopic ¶

func NewAuthTopic() *AuthTopic

func (*AuthTopic) GetDescription ¶

func (a *AuthTopic) GetDescription() string

func (*AuthTopic) GetKey ¶

func (a *AuthTopic) GetKey() string

func (*AuthTopic) GetTitle ¶

func (a *AuthTopic) GetTitle() string

func (*AuthTopic) WriteAbout ¶

func (a *AuthTopic) WriteAbout(o io.Writer) error

type BenchmarkTopic ¶

type BenchmarkTopic struct {
	Key         string
	Title       string
	Description string
	About       string
}

func NewBenchmarkTopic ¶

func NewBenchmarkTopic() *BenchmarkTopic

func (*BenchmarkTopic) GetDescription ¶

func (a *BenchmarkTopic) GetDescription() string

func (*BenchmarkTopic) GetKey ¶

func (a *BenchmarkTopic) GetKey() string

func (*BenchmarkTopic) GetTitle ¶

func (a *BenchmarkTopic) GetTitle() string

func (*BenchmarkTopic) WriteAbout ¶

func (a *BenchmarkTopic) WriteAbout(o io.Writer) error

type SubTopicInterface ¶

type SubTopicInterface interface {
	WriteSubTopic(io.Writer, string) error
}

SubTopicInterface -- Some about topics may have sub topics

type SubstitutionTopic ¶

type SubstitutionTopic struct {
	Key         string
	Title       string
	Description string
	About       string
}

func NewSubstitutionTopic ¶

func NewSubstitutionTopic() *SubstitutionTopic

func (*SubstitutionTopic) GetDescription ¶

func (a *SubstitutionTopic) GetDescription() string

func (*SubstitutionTopic) GetKey ¶

func (a *SubstitutionTopic) GetKey() string

func (*SubstitutionTopic) GetTitle ¶

func (a *SubstitutionTopic) GetTitle() string

func (*SubstitutionTopic) WriteAbout ¶

func (a *SubstitutionTopic) WriteAbout(o io.Writer) error

func (*SubstitutionTopic) WriteSubTopic ¶

func (a *SubstitutionTopic) WriteSubTopic(o io.Writer, fname string) error

type TopicInterface ¶

type TopicInterface interface {
	GetKey() string             // Key for lookup and sub-command
	GetTitle() string           // Title for help display
	GetDescription() string     // Decription of key in lists
	WriteAbout(io.Writer) error // The text to display about the topic
}

TopicInterface -- THe minumum supported interface for about topics

type VersionCommand ¶

type VersionCommand struct {
	Branch  string
	Commit  string
	Version string
}

func NewVersionCommand ¶

func NewVersionCommand() *VersionCommand

func (*VersionCommand) AddOptions ¶

func (cmd *VersionCommand) AddOptions(set shell.CmdSet)

func (*VersionCommand) Execute ¶

func (cmd *VersionCommand) Execute(args []string) error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL