advisor

package
v0.0.0-...-92b8e37 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 3, 2023 License: MIT Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Advisor

type Advisor interface {
	Entrance() string
	NodeDepth() int
	SyncDocument(document *prompt.Document)
	Suggestions() []prompt.Suggest
	ParseEntrance(nextEntrance string) Advisor
	PluginChildWithOpts(childOptions ...Options) (child Advisor)
	Handler() func(argument string)
}

func InvalidAdvisor

func InvalidAdvisor() Advisor

func NewAdvisorWithOpts

func NewAdvisorWithOpts(options ...Options) Advisor

func NoMatchedAdvisor

func NoMatchedAdvisor() Advisor

type Options

type Options func(option *implement)

func WithAdvisorBuiltinSuggestions

func WithAdvisorBuiltinSuggestions(keywords ...string) Options

func WithAdvisorChildren

func WithAdvisorChildren(nodes ...Advisor) Options

func WithAdvisorDepth

func WithAdvisorDepth(depth int) Options

func WithAdvisorEntrance

func WithAdvisorEntrance(entrance string) Options

func WithAdvisorFunctionChain

func WithAdvisorFunctionChain(functions ...func(argument string)) Options

func WithAdvisorSuggesterAppend

func WithAdvisorSuggesterAppend(functions ...SuggesterFunc) Options

func WithAdvisorSuggesterFunctions

func WithAdvisorSuggesterFunctions(functions ...SuggesterFunc) Options

type SuggesterContext

type SuggesterContext struct {
	Document *prompt.Document
	// contains filtered or unexported fields
}

func NewContext

func NewContext(d *prompt.Document, handlers ...SuggesterFunc) *SuggesterContext

func (*SuggesterContext) Abort

func (s *SuggesterContext) Abort()

func (*SuggesterContext) AppendSuggestAfter

func (s *SuggesterContext) AppendSuggestAfter(appends ...prompt.Suggest)

func (*SuggesterContext) AppendSuggestBefore

func (s *SuggesterContext) AppendSuggestBefore(appends ...prompt.Suggest)

func (*SuggesterContext) IsAborted

func (s *SuggesterContext) IsAborted() bool

func (*SuggesterContext) Next

func (s *SuggesterContext) Next()

func (*SuggesterContext) Result

func (s *SuggesterContext) Result() []prompt.Suggest

func (*SuggesterContext) ToCompleter

func (s *SuggesterContext) ToCompleter() func(d prompt.Document) []prompt.Suggest

type SuggesterFunc

type SuggesterFunc func(ctx *SuggesterContext)

Jump to

Keyboard shortcuts

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