server

package

v0.0.0-...-d262b53 Latest Latest Go to latest Published: Oct 10, 2021 License: GPL-3.0 Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Config struct {
	ListenAddr string `default:":8080" help:"port to listen on"`
}

Config defines the configuration for the longform server.

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

Server defines the necessary components to host the longform server.

func New(log *zap.Logger, cfg Config, staticFS embed.FS) (s *Server, err error)

New creates a new longform server based on the provided config and static directory.

func (server *Server) Close() error

Close closes the server.

func (server *Server) Serve() error

Serve starts the longform server.

func (server *Server) ServeStatic(w http.ResponseWriter, r *http.Request) bool

ServeStatic will serve the requested static asset if possible. If served, will return true.