requirementbrowser

Documentation

Index

• Variables
• func BuildPlan(raw any, options Options) (map[string]any, int, error)
• func BuildProjectPlan(ctx context.Context, repositoryRoot string, options Options) (map[string]any, int, error)
• func HostChoices() []string
• func Serve(ctx context.Context, raw any, options Options, stdout io.Writer) error
• func ServeProject(ctx context.Context, repositoryRoot string, options Options, stdout io.Writer) error
• func SessionModeChoices() []string
• func ViewChoices() []string
• type Options
• type ServerHandle
  • func StartProjectServer(ctx context.Context, repositoryRoot string, options Options) (ServerHandle, error)
  • func StartServer(raw any, options Options) (ServerHandle, error)
  • func (handle ServerHandle) Close(ctx context.Context) error
  • func (handle ServerHandle) Done() <-chan error

Variables

var ErrOneShotTerminal = errors.New("requirement browser one-shot terminal state")

Functions

func BuildPlan

func BuildPlan(raw any, options Options) (map[string]any, int, error)

func BuildProjectPlan

func BuildProjectPlan(ctx context.Context, repositoryRoot string, options Options) (map[string]any, int, error)

func HostChoices

func HostChoices() []string

func Serve

func Serve(ctx context.Context, raw any, options Options, stdout io.Writer) error

func ServeProject

func ServeProject(ctx context.Context, repositoryRoot string, options Options, stdout io.Writer) error

func SessionModeChoices

func SessionModeChoices() []string

func ViewChoices

func ViewChoices() []string

Types

type Options

type Options struct {
	EmptyLocalEnvironmentPolicy bool
	Host                        string
	LocalEnvironmentClasses     []string
	Open                        bool
	Port                        int
	PortSet                     bool
	ProofViewScope              string
	SessionMode                 string
	SessionTimeout              time.Duration
	View                        string
}

type ServerHandle

type ServerHandle struct {
	Host       string
	Port       int
	SnapshotID string
	URL        string
	Handoff    <-chan map[string]any
	// contains filtered or unexported fields
}

func StartProjectServer

func StartProjectServer(ctx context.Context, repositoryRoot string, options Options) (ServerHandle, error)

func StartServer

func StartServer(raw any, options Options) (ServerHandle, error)

func (ServerHandle) Close

func (handle ServerHandle) Close(ctx context.Context) error

func (ServerHandle) Done

func (handle ServerHandle) Done() <-chan error