Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ResponseWriter ¶
type ResponseWriter interface {
http.ResponseWriter
// Status returns the status code of the response or 0 if the response has
// not been written
Status() int
// Written returns whether or not the ResponseWriter has been written.
Written() bool
// Size returns the size of the response body.
Size() int
// Before allows for a function to be called before the ResponseWriter has been written to. This is
// useful for setting headers or any other operations that must happen before a response has been written.
Before(func(ResponseWriter))
// UserValue retrieves values from the object.
UserValue(key any) any
// UserValueString retrieves the user value and casts it as string.
// If the value is not a string, returns an empty string.
UserValueString(key any) string
// AllUserValues retrieves all user values.
AllUserValues() map[any]any
// SetUserValue sets arbitrary values in the object.
SetUserValue(key any, value any)
}
ResponseWriter is a wrapper around http.ResponseWriter that provides extra information about the response. It is recommended that middleware handlers use this construct to wrap a responsewriter if the functionality calls for it.
func EnsureResponseWriter ¶
func EnsureResponseWriter(rw http.ResponseWriter) ResponseWriter
EnsureResponseWriter creates a ResponseWriter that wraps a http.ResponseWriter, unless it's already a ResponseWriter.
func NewResponseWriter ¶
func NewResponseWriter(rw http.ResponseWriter) ResponseWriter
NewResponseWriter creates a ResponseWriter that wraps a http.ResponseWriter
Click to show internal directories.
Click to hide internal directories.