api

Documentation

Index

• type Builder
• type BuilderSupport
• type Command
• type ConfigAPI
• type RenderAPI

Types

type Builder

type Builder interface {
	AddArgument(string)
	AddPreposition(string)
	Command() (Command, error)
}

type BuilderSupport

type BuilderSupport interface {
	// AddArgument(string) // must be provided by each command
	AddPreposition(string) // not required by all commands
	ColumnSpecifierFromArg(string) *column.Specifier
	IsKeyword(string, keyword.ID) bool
	KeywordName(keyword.ID) string
}

API provided by the parser to the command builders, allowing them to perform common tasks such as looking up keywords etc

type Command

type Command interface {
	Name() string
	String() string
	ApplyConfig(ConfigAPI)
	ApplyRenderCommands(RenderAPI)
}

each command provides the following abilities

type ConfigAPI

type ConfigAPI interface {
	SetPrefix(string)
	SetPrefixPattern(string)
	SetProfile(*profile.Profile)
	SetLocaleTag(string)
}

API used by commands to perform their actions BEFORE importing data into a table

type RenderAPI

type RenderAPI interface {
	Index() column.Index
	SetIndex(column.Index)
	FillColumns([]*column.Specifier, string)
}

API used by commands to perform their actions before rendering a table