api

Documentation

Index

• type Builder
• type BuilderSupport
• type ConfigAPI
• type Directive
• type RenderAPI

Types

type Builder

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

type BuilderSupport

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

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

type ConfigAPI

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

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

type Directive

type Directive interface {
	Name() string
	String() string
	ApplyConfig(ConfigAPI)
	ApplyRenderDirectives(RenderAPI)
}

each directive provides the following abilities

type RenderAPI

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

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