response

Documentation

Index

• func HandlerStatus(err error, fallback int) int
• func NewHandlerError(status int, message string, cause error) error
• func ValidationHTML(result validation.Result) string
• func WriteHTML(writer http.ResponseWriter, request *http.Request, body string, ...) error
• func WriteHTTP(writer http.ResponseWriter, result Response) error
• func WriteNoStoreError(writer http.ResponseWriter, status int, message string)
• func WriteNoStoreHTML(writer http.ResponseWriter, request *http.Request, body string) error
• func WriteNoStoreHTTP(writer http.ResponseWriter, result Response) error
• type HandlerError
  • func (err HandlerError) Error() string
  • func (err HandlerError) Unwrap() error
• type Kind
• type Response
  • func FragmentFor(target, body string) Response
  • func FragmentSwap(target string, swap SwapMode, body string) (Response, error)
  • func HTMLBody(status int, body string) Response
  • func JSONBody(status int, body string) Response
  • func JSONValue(status int, value any) (Response, error)
  • func RedirectTo(url string) Response
  • func ReloadPage() Response
  • func ValidationFragment(target string, result validation.Result) Response
  • func ValidationJSON(result validation.Result) (Response, error)
  • func WithCookie(result Response, cookie http.Cookie) Response
• type SwapMode

Functions

func HandlerStatus

func HandlerStatus(err error, fallback int) int

HandlerStatus returns a handler error status, or fallback for ordinary errors.

func NewHandlerError

func NewHandlerError(status int, message string, cause error) error

NewHandlerError creates an error suitable for generated handlers.

func ValidationHTML

func ValidationHTML(result validation.Result) string

ValidationHTML renders a small escaped validation message block.

func WriteHTML

func WriteHTML(writer http.ResponseWriter, request *http.Request, body string, cacheControl string) error

WriteHTML writes an HTML response with an explicit Cache-Control policy and suppresses the body for HEAD requests. An empty cache policy falls back to no-store for request-time safety.

func WriteHTTP

func WriteHTTP(writer http.ResponseWriter, result Response) error

WriteHTTP writes a runtime response envelope to net/http.

func WriteNoStoreError

func WriteNoStoreError(writer http.ResponseWriter, status int, message string)

WriteNoStoreError writes an HTTP error that must not be cached.

func WriteNoStoreHTML

func WriteNoStoreHTML(writer http.ResponseWriter, request *http.Request, body string) error

WriteNoStoreHTML writes a no-store HTML response and suppresses the body for HEAD requests.

func WriteNoStoreHTTP

func WriteNoStoreHTTP(writer http.ResponseWriter, result Response) error

WriteNoStoreHTTP writes a response envelope that must not be cached.

Types

type HandlerError

type HandlerError struct {
	Status  int
	Message string
	Cause   error
}

HandlerError wraps failures raised by generated handlers.

func (HandlerError) Error

func (err HandlerError) Error() string

func (HandlerError) Unwrap

func (err HandlerError) Unwrap() error

type Kind

type Kind string

Kind identifies the response shape produced by actions, fragments, APIs, or full-page rendering.

const (
	HTML     Kind = "html"
	Redirect Kind = "redirect"
	Fragment Kind = "fragment"
	JSON     Kind = "json"
	Reload   Kind = "reload"
)

type Response

type Response struct {
	Kind    Kind
	Status  int
	Body    string
	Target  string
	Swap    SwapMode
	URL     string
	Cookies []http.Cookie
}

Response is the generated runtime response envelope.

func FragmentFor

func FragmentFor(target, body string) Response

FragmentFor creates a partial fragment response for a DOM target.

func FragmentSwap

func FragmentSwap(target string, swap SwapMode, body string) (Response, error)

FragmentSwap creates a partial fragment response with an explicit swap mode.

func HTMLBody

func HTMLBody(status int, body string) Response

HTMLBody creates a full HTML response.

func JSONBody

func JSONBody(status int, body string) Response

JSONBody creates a JSON response from an already-encoded body.

func JSONValue

func JSONValue(status int, value any) (Response, error)

JSONValue marshals a value into a JSON response body.

func RedirectTo

func RedirectTo(url string) Response

RedirectTo creates a redirect response.

func ReloadPage

func ReloadPage() Response

ReloadPage asks enhanced clients to reload the current page. Non-enhanced forms should still use normal POST/redirect/get behavior.

func ValidationFragment

func ValidationFragment(target string, result validation.Result) Response

ValidationFragment creates a fragment response with escaped validation messages. It uses HTTP 200 so progressively enhanced partial forms can swap the returned fragment with the current client runtime.

func ValidationJSON

func ValidationJSON(result validation.Result) (Response, error)

ValidationJSON creates a structured validation error response.

func WithCookie

func WithCookie(result Response, cookie http.Cookie) Response

WithCookie returns a copy of result that sets cookie when written to HTTP.

type SwapMode

type SwapMode string

SwapMode identifies how a fragment response should update its target.

const (
	SwapInnerHTML SwapMode = "innerHTML"
	SwapOuterHTML SwapMode = "outerHTML"
)