package lazycontroller ¶
import "golazy.dev/lazycontroller"Constants ¶
const LazyDevOpenEditorPath ¶
const LazyDevOpenEditorPath = "/_golazy/open-editor"Functions ¶
func DefaultViews ¶
DefaultViews returns the framework-owned fallback view filesystem.
lazyapp layers application views over these files so apps can override layouts/app.html.tpl or app/error.html.tpl with ordinary view files.
func DefaultViews() (fs.FS, error)func DetailErrors ¶
func DetailErrors(ctx context.Context) boolfunc Error ¶
func Error(status int, err error) errorfunc ErrorHandler ¶
func ErrorHandler(ctx context.Context) func(http.Handler) http.Handlerfunc LazyDevContext ¶
func LazyDevContext(ctx context.Context) context.Contextfunc PanicError ¶
func PanicError(recovered any) errorfunc RegisterFormat ¶
RegisterFormat maps one or more content types to a controller format.
func RegisterFormat(format Format, contentTypes ...string)func RegisterFormatSuffix ¶
RegisterFormatSuffix maps one or more URL suffixes to a controller format.
func RegisterFormatSuffix(format Format, suffixes ...string)func RegisterLazyDevHandlers ¶
func RegisterLazyDevHandlers(controlPlane *lazycontrolplane.ControlPlane)func ReportController ¶
func ReportController(r *http.Request, controller any) boolfunc ReportError ¶
func ReportError(r *http.Request, controller any, err error) boolfunc ResetResponse ¶
func ResetResponse(w http.ResponseWriter) boolfunc StatusCode ¶
func StatusCode(err error) intfunc WasResponseSent ¶
func WasResponseSent(w http.ResponseWriter) boolfunc WithDetailErrors ¶
func WithDetailErrors(ctx context.Context) context.Contextfunc WithErrorPages ¶
func WithErrorPages(ctx context.Context, files fs.FS) context.Contextfunc WithFormat ¶
WithFormat returns a context that carries an explicitly requested format.
func WithFormat(ctx context.Context, format Format) context.Contextfunc WithOpenEditorPath ¶
WithOpenEditorPath records the development endpoint used by error pages to open a backtrace frame in the user's editor.
func WithOpenEditorPath(ctx context.Context, path string) context.Contextfunc WithPathFor ¶
WithPathFor returns a context carrying the application's route path helper.
func WithPathFor(ctx context.Context, pathFor PathForFunc) context.Contextfunc WithRenderer ¶
func WithRenderer(ctx context.Context, renderer *Renderer) context.Contextfunc WriteError ¶
func WriteError(w http.ResponseWriter, _ *http.Request, err error)func WriteErrorDetail ¶
func WriteErrorDetail(w http.ResponseWriter, _ *http.Request, err error)func WriteErrorFallback ¶
func WriteErrorFallback(ctx context.Context, w http.ResponseWriter, r *http.Request) boolfunc WriteErrorPage ¶
func WriteErrorPage(ctx context.Context, w http.ResponseWriter, r *http.Request, status int) boolfunc WriteFile ¶
func WriteFile(ctx context.Context, w http.ResponseWriter, r *http.Request, file string, status int) errorTypes ¶
type Base ¶
type Base struct {
// contains filtered or unexported fields
}func NewBase ¶
func NewBase(ctx context.Context, viewPath ...string) (Base, error)func (b *Base) Alternate ¶
func (b *Base) Alternate(language, url string) *lazyseo.Metafunc (b *Base) Author ¶
func (b *Base) Author(value string) *lazyseo.Metafunc (b *Base) BindRequest ¶
func (b *Base) BindRequest(w http.ResponseWriter, r *http.Request, route lazyview.Route) errorfunc (b *Base) Cache ¶
func (b *Base) Cache() *lazycache.Cachefunc (b *Base) CacheKey ¶
func (b *Base) CacheKey(parts ...any) boolfunc (b *Base) CacheKeyF ¶
func (b *Base) CacheKeyF(parts ...any) boolfunc (b *Base) Canonical ¶
func (b *Base) Canonical(value string) *lazyseo.Metafunc (b *Base) ContentType ¶
ContentType sets the response Content-Type header.
func (b *Base) ContentType(value string)func (b *Base) Decode ¶
Decode parses the current request form and decodes submitted fields into target.
func (b *Base) Decode(target any) errorfunc (b *Base) Description ¶
func (b *Base) Description(value string) *lazyseo.Metafunc (b *Base) Format ¶
Format returns the negotiated response format for the current request.
func (b *Base) Format() Formatfunc (b *Base) HandleError ¶
func (b *Base) HandleError(w http.ResponseWriter, r *http.Request, err error) errorfunc (b *Base) Header ¶
Header returns the response header map for the current controller request.
func (b *Base) Header() http.Headerfunc (b *Base) Helper ¶
func (b *Base) Helper(name string, helper any)func (b *Base) Helpers ¶
func (b *Base) Helpers(helpers map[string]any)func (b *Base) Is ¶
Is reports whether the current request resolved to format.
func (b *Base) Is(format Format) boolfunc (b *Base) IsGIF ¶
func (b *Base) IsGIF() boolfunc (b *Base) IsHTML ¶
func (b *Base) IsHTML() boolfunc (b *Base) IsImage ¶
func (b *Base) IsImage() boolfunc (b *Base) IsJPEG ¶
func (b *Base) IsJPEG() boolfunc (b *Base) IsJSON ¶
func (b *Base) IsJSON() boolfunc (b *Base) IsPNG ¶
func (b *Base) IsPNG() boolfunc (b *Base) IsSSE ¶
func (b *Base) IsSSE() boolfunc (b *Base) IsTurboFrame ¶
func (b *Base) IsTurboFrame() boolfunc (b *Base) IsTurboStream ¶
func (b *Base) IsTurboStream() boolfunc (b *Base) JSONLD ¶
func (b *Base) JSONLD(value any) *lazyseo.Metafunc (b *Base) Kind ¶
func (b *Base) Kind(kind lazyseo.PageKind) *lazyseo.Metafunc (b *Base) Language ¶
func (b *Base) Language(value string) *lazyseo.Metafunc (b *Base) LastUpdated ¶
func (b *Base) LastUpdated(value time.Time) *lazyseo.Metafunc (b *Base) Layout ¶
func (b *Base) Layout(layout string)func (b *Base) Locale ¶
func (b *Base) Locale(value string) *lazyseo.Metafunc (b *Base) Metadata ¶
func (b *Base) Metadata(model any) *lazyseo.Metafunc (b *Base) MustPathFor ¶
MustPathFor builds a path and panics when the route cannot be generated.
func (b *Base) MustPathFor(name string, values ...any) stringfunc (b *Base) NoLayout ¶
func (b *Base) NoLayout()func (b *Base) OpenGraph ¶
func (b *Base) OpenGraph(value lazyseo.OpenGraph) *lazyseo.Metafunc (b *Base) OpenGraphType ¶
func (b *Base) OpenGraphType(value string) *lazyseo.Metafunc (b *Base) PathFor ¶
PathFor builds a path from a named route and route parameter values.
func (b *Base) PathFor(name string, values ...any) (string, error)func (b *Base) PublishedTime ¶
func (b *Base) PublishedTime(value time.Time) *lazyseo.Metafunc (b *Base) Redirect ¶
Redirect sends an HTTP redirect and marks the controller response as written. It defaults to 302 Found. Pass a single 3xx status such as http.StatusMovedPermanently or http.StatusSeeOther to override it.
func (b *Base) Redirect(location string, status ...int) errorfunc (b *Base) RedirectBack ¶
RedirectBack is an alias for RedirectBackOrTo.
func (b *Base) RedirectBack(fallbackLocation string, status ...int) errorfunc (b *Base) RedirectBackOrTo ¶
RedirectBackOrTo redirects to the same-host Referer header when present, otherwise it redirects to fallbackLocation.
func (b *Base) RedirectBackOrTo(fallbackLocation string, status ...int) errorfunc (b *Base) RedirectTo ¶
RedirectTo is an alias for Redirect for controllers that prefer Rails-style wording in action code.
func (b *Base) RedirectTo(location string, status ...int) errorfunc (b *Base) Render ¶
func (b *Base) Render(view string) errorfunc (b *Base) RenderHTML ¶
func (b *Base) RenderHTML(view string) errorfunc (b *Base) RenderSVGString ¶
func (b *Base) RenderSVGString(view string, variants ...string) (string, error)func (b *Base) RenderTurboFrame ¶
func (b *Base) RenderTurboFrame(id string, opts ...lazyturbo.FrameOption) errorfunc (b *Base) Request ¶
func (b *Base) Request() *http.Requestfunc (b *Base) ResetRequest ¶
func (b *Base) ResetRequest()func (b *Base) Respond ¶
Respond runs the response handler matching the request format.
func (b *Base) Respond(responses Responses) errorfunc (b *Base) ReturnFile ¶
func (b *Base) ReturnFile(file string, status int) errorfunc (b *Base) SEO ¶
func (b *Base) SEO(options ...lazyseo.Option) *lazyseo.Metafunc (b *Base) SEOImage ¶
func (b *Base) SEOImage(value string) *lazyseo.Metafunc (b *Base) SEOImageAlt ¶
func (b *Base) SEOImageAlt(value string) *lazyseo.Metafunc (b *Base) SSEStream ¶
SSEStream starts a Server-Sent Events response for the current controller request.
func (b *Base) SSEStream(opts ...lazysse.Option) (*lazysse.Stream, error)func (b *Base) SchemaType ¶
func (b *Base) SchemaType(value string) *lazyseo.Metafunc (b *Base) ServeErrorPage ¶
func (b *Base) ServeErrorPage(w http.ResponseWriter, r *http.Request, status int) boolfunc (b *Base) Set ¶
func (b *Base) Set(name string, value any)func (b *Base) SetLater ¶
SetLater stores a Valuer and starts loading it immediately.
func (b *Base) SetLater(name string, loader any) Valuerfunc (b *Base) SetTurboFrameOptions ¶
func (b *Base) SetTurboFrameOptions(opts ...lazyturbo.FrameOption)func (b *Base) SetWhenNeeded ¶
SetWhenNeeded stores a Valuer that loads on its first Value call.
func (b *Base) SetWhenNeeded(name string, loader any) Valuerfunc (b *Base) Status ¶
Status sets the HTTP status code used by the next controller render.
It does not write the response immediately, so actions can still rely on automatic rendering after setting a non-200 status.
func (b *Base) Status(code int)func (b *Base) Title ¶
func (b *Base) Title(value string) *lazyseo.Metafunc (b *Base) TwitterCard ¶
func (b *Base) TwitterCard(value lazyseo.TwitterCard) *lazyseo.Metafunc (b *Base) TwitterCardType ¶
func (b *Base) TwitterCardType(value string) *lazyseo.Metafunc (b *Base) Type ¶
func (b *Base) Type(value string) *lazyseo.Metafunc (b *Base) URL ¶
func (b *Base) URL(value string) *lazyseo.Metafunc (b *Base) URLFrom ¶
URLFrom returns location when it is safe to use as an internal redirect target for the current request. Absolute URLs must match the request host; relative URLs must be absolute paths such as "/posts".
func (b *Base) URLFrom(location string) stringfunc (b *Base) Variants ¶
func (b *Base) Variants(variants ...string)func (b *Base) Wants ¶
Wants runs the response handler matching the request format.
func (b *Base) Wants(formats Formats) errortype BeforeAction ¶
BeforeAction runs after request binding and before the routed action.
type BeforeAction interface {
BeforeAction() error
}type Format ¶
Format identifies the response representation selected for a request.
type Format stringfunc FormatFromContentType ¶
FormatFromContentType resolves a content type to a registered format.
func FormatFromContentType(contentType string) (Format, bool)func FormatFromRequest ¶
FormatFromRequest returns the request format inferred from Turbo headers, explicit route metadata, and Accept.
func FormatFromRequest(r *http.Request) Formatfunc FormatFromSuffix ¶
FormatFromSuffix resolves a URL suffix to a registered format.
func FormatFromSuffix(suffix string) (Format, bool)func NewFormat ¶
NewFormat registers a custom MIME type and returns its symbolic format.
func NewFormat(contentType string, options ...FormatOption) Formattype FormatOption ¶
FormatOption configures a custom format created by NewFormat.
type FormatOption func(*newFormatOptions)func As ¶
As sets the symbolic format name returned by NewFormat.
func As(name string) FormatOptionfunc Suffix ¶
Suffix registers one or more URL suffixes for a custom format.
func Suffix(suffixes ...string) FormatOptiontype Formats ¶
type Formats map[Format]func() errortype HTTPError ¶
type HTTPError struct {
Status int
Err error
}func (e *HTTPError) Error ¶
func (e *HTTPError) Error() stringfunc (e *HTTPError) Unwrap ¶
func (e *HTTPError) Unwrap() errortype PathForFunc ¶
PathForFunc builds a path from a named route and route parameter values.
type PathForFunc func(name string, values ...any) (string, error)type Renderer ¶
Renderer is the application view renderer.
type Renderer = lazyview.Viewsfunc NewRenderer ¶
func NewRenderer(views fs.FS) (*Renderer, error)func RendererFromContext ¶
func RendererFromContext(ctx context.Context) (*Renderer, bool)type RequestBinder ¶
RequestBinder prepares a controller instance for one request.
type RequestBinder interface {
BindRequest(http.ResponseWriter, *http.Request, lazyview.Route) error
}type RequestResetter ¶
RequestResetter clears request-specific references before a controller returns to a pool.
type RequestResetter interface {
ResetRequest()
}type Responses ¶
type Responses = Formatstype URLParams ¶
URLParams appends query parameters to a generated route path.
type URLParams = lazypath.URLParamstype Valuer ¶
Valuer resolves request-local view data when a template or controller needs it.
type Valuer interface {
Value() (any, error)
}
Package lazycontroller provides request-local controller state, rendering helpers, response helpers, cache-key helpers, deferred view values, typed HTTP errors, redirects, content negotiation, SEO convenience methods, and Server-Sent Events entrypoints.
In a normal GoLazy app, lazyapp creates a renderer, stores it in context, and lazyroutes binds a fresh controller instance to each request. Controllers then embed Base, call Set before rendering, return errors for framework error handling, and let empty successful actions render the matching view automatically.
The package can also be used without lazyapp. Create a Renderer from an fs.FS, put it in context with WithRenderer, construct Base with NewBase, and bind each request with BindRequest before rendering.