apiserver

Documentation

Index

• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func Handler(logger *slog.Logger, defaultLogLevel slog.Level) http.Handler
• func LogsHandler(logger *slog.Logger, defaultLevel slog.Level, leveler Leveler) http.Handler
• func MustAsset(name string) []byte
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• type Leveler
• type LevelerFunc
  • func (f LevelerFunc) Level(req *http.Request) slog.Level
• type Server
  • func New(addr string, logger *slog.Logger, defaultLogLevel slog.Level) *Server

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func Handler

func Handler(logger *slog.Logger, defaultLogLevel slog.Level) http.Handler

Handler returns an http.Handler that responds properly to all apiserver routes.

func LogsHandler

func LogsHandler(logger *slog.Logger, defaultLevel slog.Level, leveler Leveler) http.Handler

LogsHandler returns an http.Handler that will push JSON formatted log messages to the client. Handler should only be called once per logger. By default, each request is configured to receive logs at defaultLevel or higher. If you would like to be able to set a custom logLevel per websocket connection, use the Leveler interface to determine what level the request should use.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

Types

type Leveler

type Leveler interface {
	Level(req *http.Request) slog.Level
}

A Leveler is used to determine from an http.Request the logLevel that should be used for the websocket.

type LevelerFunc

type LevelerFunc func(*http.Request) slog.Level

LevelerFunc is a convenience wrapper to create a Leveler.

func (LevelerFunc) Level

func (f LevelerFunc) Level(req *http.Request) slog.Level

Level implements the Leveler interface.

type Server

type Server struct {
	simpleserver.Server
}

A Server defines parameters for running an apiserver http server.

func New

func New(addr string, logger *slog.Logger, defaultLogLevel slog.Level) *Server

New allocates a new apiserver Server.