serve

Documentation

Overview

Package serve implements the "jig serve" command, serving GRPC services via an evaluator.

Index

• func NewFS(vfs ...fs.FS) fs.FS
• func NewFSFromDirs(dirs ...string) fs.FS
• type Evaluator
  • func JsonnetEvaluator() Evaluator
• type EvaluatorFunc
  • func (ef EvaluatorFunc) Evaluate(method, input string, vfs fs.FS) (output string, err error)
• type Option
  • func WithLogger(logger log.Logger) Option
  • func WithProtosets(protosets ...string) Option
• type Server
  • func NewServer(eval Evaluator, vfs fs.FS, options ...Option) (*Server, error)
  • func (s *Server) ListenAndServe(listenAddr string) error
  • func (s *Server) Serve(lis net.Listener) error
  • func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (s *Server) Stop()
• type TestServer
  • func NewTestServer(eval Evaluator, vfs fs.FS, options ...Option) *TestServer
  • func (ts *TestServer) Addr() string

Functions

func NewFS

func NewFS(vfs ...fs.FS) fs.FS

NewFS combines the top level directories of multiple fs.FS.

func NewFSFromDirs

func NewFSFromDirs(dirs ...string) fs.FS

NewFSFromDirs combines the top level directories of multiple directories.

Types

type Evaluator

type Evaluator interface {
	Evaluate(method, input string, vfs fs.FS) (output string, err error)
}

func JsonnetEvaluator

func JsonnetEvaluator() Evaluator

type EvaluatorFunc

type EvaluatorFunc func(method, input string, vfs fs.FS) (output string, err error)

func (EvaluatorFunc) Evaluate

func (ef EvaluatorFunc) Evaluate(method, input string, vfs fs.FS) (output string, err error)

type Option

type Option func(s *Server) error

Option is a functional option to configure Server

func WithLogger

func WithLogger(logger log.Logger) Option

func WithProtosets

func WithProtosets(protosets ...string) Option

type Server

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

func NewServer

func NewServer(eval Evaluator, vfs fs.FS, options ...Option) (*Server, error)

NewServer creates a new Server for given evaluator, e.g. Jsonnet and data Directories.

func (*Server) ListenAndServe

func (s *Server) ListenAndServe(listenAddr string) error

func (*Server) Serve

func (s *Server) Serve(lis net.Listener) error

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*Server) Stop

func (s *Server) Stop()

type TestServer

type TestServer struct {
	Server
	// contains filtered or unexported fields
}

func NewTestServer

func NewTestServer(eval Evaluator, vfs fs.FS, options ...Option) *TestServer

NewTestServer starts and returns a new TestServer. The caller should call Stop when finished, to shut it down.

func (*TestServer) Addr

func (ts *TestServer) Addr() string