mode

Documentation

Overview

Package mode provides entrypoints for all modes that are provided from Evans.

Index

• Variables
• func IsCLIMode(file string) bool
• func RunAsCLIMode(cfg *config.Config, invoker CLIInvoker) error
• func RunAsREPLMode(cfg *config.Config, ui cui.UI, cache *cache.Cache) error
• type CLIInvoker
  • func NewCallCLIInvoker(ui cui.UI, methodName string, opt *CallCLIInvokerOption) (CLIInvoker, error)
  • func NewDescribeCLIInvoker(ui cui.UI, fqn string) CLIInvoker
  • func NewListCLIInvoker(ui cui.UI, fqn, format string) CLIInvoker
• type CallCLIInvokerOption

Variables

var DefaultCLIReader io.Reader = os.Stdin

DefaultCLIReader is the reader that is read for inputting request values. It is exported for E2E testing.

Functions

func IsCLIMode

func IsCLIMode(file string) bool

IsCLIMode returns whether Evans is launched as CLI mode or not.

func RunAsCLIMode

func RunAsCLIMode(cfg *config.Config, invoker CLIInvoker) error

RunAsCLIMode starts Evans as CLI mode.

func RunAsREPLMode

func RunAsREPLMode(cfg *config.Config, ui cui.UI, cache *cache.Cache) error

Types

type CLIInvoker

type CLIInvoker func(context.Context) error

CLIInvoker represents an invokable function for CLI mode.

func NewCallCLIInvoker

func NewCallCLIInvoker(ui cui.UI, methodName string, opt *CallCLIInvokerOption) (CLIInvoker, error)

NewCallCLIInvoker returns an CLIInvoker implementation for calling RPCs.

func NewDescribeCLIInvoker

func NewDescribeCLIInvoker(ui cui.UI, fqn string) CLIInvoker

func NewListCLIInvoker

func NewListCLIInvoker(ui cui.UI, fqn, format string) CLIInvoker

type CallCLIInvokerOption

type CallCLIInvokerOption struct {
	Headers      config.Header
	Enrich       bool
	EmitDefaults bool
	FilePath     string // If empty, the invoker tries to read input from stdin.
	FormatType   string
}