interactive

Documentation

Index

• type AfterPromptCloseAction
• type Highlighter
  • func (h *Highlighter) Highlight(d prompt.Document) ([]byte, error)
• type InteractiveClient
  • func (c *InteractiveClient) ClosePrompt(afterClose AfterPromptCloseAction)
  • func (c *InteractiveClient) InteractivePrompt(parentContext context.Context)
• type RunInteractivePromptResult
  • func RunInteractivePrompt(ctx context.Context, initData *query.InitData) *RunInteractivePromptResult

Types

type AfterPromptCloseAction

type AfterPromptCloseAction int

const (
	AfterPromptCloseExit AfterPromptCloseAction = iota
	AfterPromptCloseRestart
)

type Highlighter

type Highlighter struct {
	// contains filtered or unexported fields
}

func (*Highlighter) Highlight

func (h *Highlighter) Highlight(d prompt.Document) ([]byte, error)

type InteractiveClient

type InteractiveClient struct {
	// contains filtered or unexported fields
}

InteractiveClient is a wrapper over a LocalClient and a Prompt to facilitate interactive query prompt

func (*InteractiveClient) ClosePrompt

func (c *InteractiveClient) ClosePrompt(afterClose AfterPromptCloseAction)

ClosePrompt cancels the running prompt, setting the action to take after close

func (*InteractiveClient) InteractivePrompt

func (c *InteractiveClient) InteractivePrompt(parentContext context.Context)

InteractivePrompt starts an interactive prompt and return

type RunInteractivePromptResult

type RunInteractivePromptResult struct {
	Streamer  *queryresult.ResultStreamer
	PromptErr error
}

func RunInteractivePrompt

func RunInteractivePrompt(ctx context.Context, initData *query.InitData) *RunInteractivePromptResult

RunInteractivePrompt starts the interactive query prompt