Documentation
¶
Index ¶
- Variables
- type ConfigDirectiveAPI
- type Option
- type Options
- func (o *Options) Configure(opts ...Option)
- func (o *Options) DirectiveArgs() []string
- func (o *Options) Directives() []api.Directive
- func (o *Options) Errors() error
- func (o *Options) LocaleTag() string
- func (o *Options) Prefix(matchedPrefix string) string
- func (o *Options) PrefixMatcher() *prefix.Matcher
- func (o *Options) Profile() *profile.Profile
- func (o *Options) String() string
Constants ¶
This section is empty.
Variables ¶
View Source
var (
ErrNilOptions = errors.New("attempted to configure a nil option set")
)
Functions ¶
This section is empty.
Types ¶
type ConfigDirectiveAPI ¶ added in v0.4.30
type ConfigDirectiveAPI struct {
*Options
}
ConfigDirectiveAPI provides an indirect API for user directive interactions with a Table - without causing cyclic imports :-(
func (*ConfigDirectiveAPI) SetLocaleTag ¶ added in v0.4.30
func (cfg *ConfigDirectiveAPI) SetLocaleTag(localeTag string)
func (*ConfigDirectiveAPI) SetPrefix ¶ added in v0.4.30
func (cfg *ConfigDirectiveAPI) SetPrefix(prefix string)
func (*ConfigDirectiveAPI) SetPrefixPattern ¶ added in v0.4.30
func (cfg *ConfigDirectiveAPI) SetPrefixPattern(pattern string)
func (*ConfigDirectiveAPI) SetProfile ¶ added in v0.4.30
func (cfg *ConfigDirectiveAPI) SetProfile(profile *profile.Profile)
type Option ¶
func WithDirectiveArgs ¶ added in v0.4.30
any number of inline directives, e.g. sort insert wip delete bad ...
func WithMatchPattern ¶ added in v0.4.30
see also "prefix" directive
type Options ¶
type Options struct {
// contains filtered or unexported fields
}
Options provides configuration parameters for tables and documents
By default, the options for a document or table are nil.
- All options MUST be set via the appropriate With{Option} function.
- All options are provided as pointer methods which return default values for nil pointers!
func (*Options) DirectiveArgs ¶ added in v0.4.30
func (*Options) Directives ¶ added in v0.4.30
func (*Options) PrefixMatcher ¶
Click to show internal directories.
Click to hide internal directories.