Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

engine

package

Go to main page

Versions in this module

v0

v0.50.6

May 16, 2024

v0.50.5

May 15, 2024

v0.50.4

May 15, 2024

v0.50.3

May 15, 2024

v0.50.2

May 15, 2024

v0.50.1

May 14, 2024

v0.50.0

May 14, 2024

Changes in this version

+ const HeaderAcceptRanges

+ const HeaderRange

+ func Download(url url.URL, outputFilepath string, parallelism int, tlsSkipVerify bool, ...) (*time.Duration, error)

+ type Part struct

+ End int64

+ Size int64

+ Start int64

v0.49.1

May 2, 2024

v0.49.0

May 2, 2024

v0.48.2

Apr 29, 2024

Changes in this version

+ type ProblemKind int

v0.48.1

Apr 25, 2024

v0.48.0

Apr 25, 2024

v0.47.0

Apr 22, 2024

Changes in this version

+ const FormatGeoJSON

+ const FormatGzip

+ const FormatHTML

+ const FormatJSON

+ const FormatJSONFG

+ const FormatMVT

+ const FormatMVTAlternative

+ const FormatMapboxStyle

+ const FormatParam

+ const FormatSLD

+ const FormatTileJSON

+ const HTMLRegex

+ const HeaderAPIVersion

+ const HeaderAccept

+ const HeaderAcceptLanguage

+ const HeaderBaseURL

+ const HeaderContentCrs

+ const HeaderContentEncoding

+ const HeaderContentLength

+ const HeaderContentType

+ const HeaderLink

+ const HeaderRequestedWith

+ const MediaTypeGeoJSON

+ const MediaTypeHTML

+ const MediaTypeJSON

+ const MediaTypeJSONFG

+ const MediaTypeMVT

+ const MediaTypeMapboxStyle

+ const MediaTypeOpenAPI

+ const MediaTypeQuantizedMesh

+ const MediaTypeSLD

+ const MediaTypeTileJSON

+ var CompressibleMediaTypes = []string

+ var MediaTypeJSONFamily = []string

+ var Now = time.Now

+ var OutputFormatDefault = map[string]string

+ var OutputFormatFeatures = map[string]string

+ var ProblemBadGateway = problem.Of(http.StatusBadGateway).Append(problem.Detail(defaultMessageBadGateway))

+ var ProblemBadRequest = problem.Of(http.StatusBadRequest)

+ var ProblemNotAcceptable = problem.Of(http.StatusNotAcceptable)

+ var ProblemNotFound = problem.Of(http.StatusNotFound)

+ var ProblemServerError = problem.Of(http.StatusInternalServerError).Append(problem.Detail(defaultMessageServerErr))

+ var StyleFormatExtension = map[string]string

+ func RenderProblem(p *problem.Problem, w http.ResponseWriter, details ...string)

+ func SafeWrite(write func([]byte) (int, error), body []byte)

+ type Breadcrumb struct

+ Name string

+ Path string

+ type ContentNegotiation struct

+ func (cn *ContentNegotiation) GetStyleFormatExtension(format string) string

+ func (cn *ContentNegotiation) GetSupportedStyleFormats() []string

+ func (cn *ContentNegotiation) NegotiateFormat(req *http.Request) string

+ func (cn *ContentNegotiation) NegotiateLanguage(w http.ResponseWriter, req *http.Request) language.Tag

+ type Engine struct

+ CN *ContentNegotiation

+ Config *config.Config

+ OpenAPI *OpenAPI

+ Router *chi.Mux

+ Templates *Templates

+ func NewEngine(configFile string, openAPIFile string, enableTrailingSlash bool, ...) (*Engine, error)

+ func NewEngineWithConfig(config *config.Config, openAPIFile string, enableTrailingSlash bool, ...) *Engine

+ func (e *Engine) ParseTemplate(key TemplateKey)

+ func (e *Engine) RebuildOpenAPI(openAPIParams any)

+ func (e *Engine) RegisterShutdownHook(fn func())

+ func (e *Engine) RenderAndServePage(w http.ResponseWriter, r *http.Request, key TemplateKey, params any, ...)

+ func (e *Engine) RenderTemplates(urlPath string, breadcrumbs []Breadcrumb, keys ...TemplateKey)

+ func (e *Engine) RenderTemplatesWithParams(params any, breadcrumbs []Breadcrumb, keys ...TemplateKey)

+ func (e *Engine) ReverseProxy(w http.ResponseWriter, r *http.Request, target *url.URL, prefer204 bool, ...)

+ func (e *Engine) ReverseProxyAndValidate(w http.ResponseWriter, r *http.Request, target *url.URL, prefer204 bool, ...)

+ func (e *Engine) ServePage(w http.ResponseWriter, r *http.Request, templateKey TemplateKey)

+ func (e *Engine) ServeResponse(w http.ResponseWriter, r *http.Request, validateRequest bool, ...)

+ func (e *Engine) Start(address string, debugPort int, shutdownDelay int) error

+ type OpenAPI struct

+ SpecJSON []byte

+ func (o *OpenAPI) ValidateRequest(r *http.Request) error

+ func (o *OpenAPI) ValidateResponse(contentType string, body []byte, r *http.Request) error

+ type TemplateData struct

+ Breadcrumbs []Breadcrumb

+ Config *config.Config

+ Params any

+ func (td *TemplateData) AvailableFormats() map[string]string

+ func (td *TemplateData) AvailableFormatsFeatures() map[string]string

+ func (td *TemplateData) QueryString(format string) string

+ type TemplateKey struct

+ Directory string

+ Format string

+ InstanceName string

+ Language language.Tag

+ Name string

+ func ExpandTemplateKey(key TemplateKey, language language.Tag) TemplateKey

+ func NewTemplateKey(path string) TemplateKey

+ func NewTemplateKeyWithLanguage(path string, language language.Tag) TemplateKey

+ func NewTemplateKeyWithName(path string, instanceName string) TemplateKey

+ func NewTemplateKeyWithNameAndLanguage(path string, instanceName string, language language.Tag) TemplateKey

+ type Templates struct

+ ParsedTemplates map[TemplateKey]any

+ RenderedTemplates map[TemplateKey][]byte