webutil

Dec 4, 2021

Changes in this version

type PostedFile

+ ContentType string

Oct 16, 2021

Changes in this version

+ func GetHostStrict(r *http.Request) string

type CertInfo

+ func NewCertInfo(cert *tls.Certificate) (*CertInfo, error)

Sep 8, 2021

Changes in this version

type GracefulHTTPServer

+ Log logger.Log

type GracefulHTTPServerOption

+ func OptGracefulHTTPServerLog(log logger.Log) GracefulHTTPServerOption

Aug 15, 2021

Changes in this version

+ const DefaultPostedFilesMaxMemory

+ type PostedFileOption func(*PostedFilesOptions)

+ func OptPostedFilesMaxMemory(maxMemory int64) PostedFileOption

+ func OptPostedFilesParseForm(parseForm bool) PostedFileOption

+ func OptPostedFilesParseMultipartForm(parseMultipartForm bool) PostedFileOption

+ type PostedFilesOptions struct

+ MaxMemory int64

+ ParseForm bool

+ ParseMultipartForm bool

Apr 28, 2021

Changes in this version

+ const ConnectionClose

+ func GetNetConn(ctx context.Context) net.Conn

+ func WithNetConn(ctx context.Context, nc net.Conn) context.Context

+ type Ager interface

+ Age func() time.Duration

type MaxAgeListener

+ ConnsForcedClosed *expvar.Int

+ ConnsHeaderClosed *expvar.Int

+ ConnsOpened *expvar.Int

+ ForceCloseAfter time.Duration

+ HeaderCloseAfter time.Duration

+ func NewMaxAgeListener(listener net.Listener, headerCloseAfter, forceCloseAfter time.Duration) *MaxAgeListener

+ func (mal *MaxAgeListener) ApplyServer(server *http.Server)

+ func (mal *MaxAgeListener) ConnContext(ctx context.Context, nc net.Conn) context.Context

+ func (mal *MaxAgeListener) WrapHandler(handler http.Handler) http.Handler

Apr 13, 2021

Changes in this version

+ type MaxAgeConn struct

+ Created time.Time

+ func (mac MaxAgeConn) Age() time.Duration

+ type MaxAgeListener struct

+ MaxConnAge time.Duration

+ func (mal MaxAgeListener) Accept() (net.Conn, error)

+ func (mal MaxAgeListener) ConnState(nc net.Conn, cs http.ConnState)

+ type MaxAgeTransport struct

+ MaxConnAge time.Duration

+ func (mat *MaxAgeTransport) Close() error

+ func (mat *MaxAgeTransport) RoundTrip(req *http.Request) (res *http.Response, err error)

+ type MaxAger interface

+ Age func() time.Duration

Apr 2, 2021

Changes in this version

type RequestOption

+ func OptQueryValueAdd(key, value string) RequestOption

Feb 15, 2021

Changes in this version

+ const ErrNetWrite

Jan 4, 2021

Changes in this version

+ func SchemeIsSecure(scheme string) bool

Jan 3, 2021

Changes in this version

+ func Headers(from map[string]string) http.Header

+ func WithClientHTTPTrace(req *http.Request, trace *HTTPTrace) *http.Request

type CertInfo

+ SubjectCommonName string

type HTTPTrace

+ Start time.Time

type RequestOption

+ func OptHTTPClientTrace(ht *HTTPTrace) RequestOption

Dec 4, 2020

Changes in this version

+ const ContentTypeApplicationFormEncoded

+ const ContentTypeApplicationOctetStream

+ const ContentTypeApplicationXML

+ const ErrInvalidSameSite

+ const ErrInvalidSplitColonInput

+ const ErrParameterMissing

+ const ErrUnauthorized

+ const FlagHTTPRequest

+ const HSTSIncludeSubDomains

+ const HSTSMaxAgeFormat

+ const HSTSPreload

+ const MaxPostBodySize

+ const MethodConnect

+ const MethodDelete

+ const MethodGet

+ const MethodHead

+ const MethodOptions

+ const MethodPatch

+ const MethodPost

+ const MethodPut

+ const SameSiteDefault

+ const SameSiteLax

+ const SameSiteStrict

+ const TestURL

+ var HeaderAccept = http.CanonicalHeaderKey("Accept")

+ var HeaderAllow = http.CanonicalHeaderKey("Allow")

+ var HeaderAuthorization = http.CanonicalHeaderKey("Authorization")

+ var HeaderETag = http.CanonicalHeaderKey("etag")

+ var KnownExtensions = map[string]string

+ func ColorizeByStatusCode(statusCode int, value string) string

+ func ColorizeByStatusCodeWithFormatter(tf logger.TextFormatter, statusCode int, value string) string

+ func ColorizeStatusCode(statusCode int) string

+ func ColorizeStatusCodeWithFormatter(tf logger.TextFormatter, statusCode int) string

+ func DecodeBasicAuth(req *http.Request) (username, password string, err error)

+ func DetectContentType(path string) (string, error)

+ func ETag(contents []byte) string

+ func ErrIsInvalidSameSite(err error) bool

+ func ErrIsInvalidSplitColonInput(err error) bool

+ func ErrIsParameterMissing(err error) bool

+ func ErrIsUnauthorized(err error) bool

+ func FormatHeaders(tf logger.TextFormatter, keyColor ansi.Color, header http.Header) string

+ func GetContentEncoding(header http.Header) string

+ func GetContentType(header http.Header) string

+ func HTTPSRedirectFunc(rw http.ResponseWriter, req *http.Request)

+ func HeaderAny(headers http.Header, key, value string) bool

+ func HostHasPort(s string) bool

+ func IsHTTPTokenRune(r rune) bool

+ func IsValidMethod(method string) bool

+ func MustParseSameSite(sameSite string) http.SameSite

+ func NestMiddleware(action http.HandlerFunc, middleware ...Middleware) http.HandlerFunc

+ func NewHTTPRequestEventFilter(filter func(context.Context, HTTPRequestEvent) (HTTPRequestEvent, bool)) logger.Filter

+ func NewHTTPRequestEventListener(listener func(context.Context, HTTPRequestEvent)) logger.Listener

+ func NoFollowRedirects() func(req *http.Request, via []*http.Request) error

+ func ParseSameSite(sameSite string) (http.SameSite, error)

+ func RemoveHostEmptyPort(host string) string

+ func SplitColon(value string) (first, second string, err error)

+ func TLSSecureCipherSuites(tlsConfig *tls.Config)

+ type CertInfo struct

+ DNSNames []string

+ IssuerCommonName string

+ IssuerNames []string

+ NotAfter time.Time

+ NotBefore time.Time

+ func ParseCertInfo(res *http.Response) *CertInfo

+ func (ci CertInfo) IsExpired() bool

+ func (ci CertInfo) WillBeExpired(at time.Time) bool

+ type DialOption func(*net.Dialer)

+ func OptDialKeepAlive(d time.Duration) DialOption

+ func OptDialTimeout(d time.Duration) DialOption

+ type EventSource struct

+ func NewEventSource(output http.ResponseWriter) *EventSource

+ func (es *EventSource) Data(data string) error

+ func (es *EventSource) Event(name string) error

+ func (es *EventSource) EventData(name, data string) error

+ func (es *EventSource) EventDataWithID(name, data, id string) error

+ func (es *EventSource) Ping() error

+ func (es *EventSource) StartSession() error

+ type GZipResponseWriter struct

+ func NewGZipResponseWriter(w http.ResponseWriter) *GZipResponseWriter

+ func (crw *GZipResponseWriter) Close() error

+ func (crw *GZipResponseWriter) ContentLength() int

+ func (crw *GZipResponseWriter) Flush()

+ func (crw *GZipResponseWriter) Header() http.Header

+ func (crw *GZipResponseWriter) InnerResponse() http.ResponseWriter

+ func (crw *GZipResponseWriter) StatusCode() int

+ func (crw *GZipResponseWriter) Write(b []byte) (int, error)

+ func (crw *GZipResponseWriter) WriteHeader(code int)

+ type GracefulHTTPServer struct

+ Latch *async.Latch

+ Listener net.Listener

+ Server *http.Server

+ ShutdownGracePeriod time.Duration

+ func NewGracefulHTTPServer(server *http.Server, options ...GracefulHTTPServerOption) *GracefulHTTPServer

+ func (gs *GracefulHTTPServer) NotifyStarted() <-chan struct{}

+ func (gs *GracefulHTTPServer) NotifyStopped() <-chan struct{}

+ func (gs *GracefulHTTPServer) Start() (err error)

+ func (gs *GracefulHTTPServer) Stop() error

+ type GracefulHTTPServerOption func(*GracefulHTTPServer)

+ func OptGracefulHTTPServerListener(listener net.Listener) GracefulHTTPServerOption

+ func OptGracefulHTTPServerShutdownGracePeriod(d time.Duration) GracefulHTTPServerOption

+ type HTTPRequestEvent struct

+ ContentEncoding string

+ ContentLength int

+ ContentType string

+ Elapsed time.Duration

+ Header http.Header

+ Request *http.Request

+ Route string

+ StatusCode int

+ func NewHTTPRequestEvent(req *http.Request, options ...HTTPRequestEventOption) HTTPRequestEvent

+ func (e HTTPRequestEvent) Decompose() map[string]interface{}

+ func (e HTTPRequestEvent) GetFlag() string

+ func (e HTTPRequestEvent) WriteText(tf logger.TextFormatter, wr io.Writer)

+ type HTTPRequestEventOption func(*HTTPRequestEvent)

+ func OptHTTPRequestContentEncoding(contentEncoding string) HTTPRequestEventOption

+ func OptHTTPRequestContentLength(contentLength int) HTTPRequestEventOption

+ func OptHTTPRequestContentType(contentType string) HTTPRequestEventOption

+ func OptHTTPRequestElapsed(elapsed time.Duration) HTTPRequestEventOption

+ func OptHTTPRequestHeader(header http.Header) HTTPRequestEventOption

+ func OptHTTPRequestRequest(req *http.Request) HTTPRequestEventOption

+ func OptHTTPRequestRoute(route string) HTTPRequestEventOption

+ func OptHTTPRequestStatusCode(statusCode int) HTTPRequestEventOption

+ type HTTPServerOption func(*http.Server) error

+ func OptHTTPServerAddr(addr string) HTTPServerOption

+ func OptHTTPServerBaseContext(baseContextProvider func(net.Listener) context.Context) HTTPServerOption

+ func OptHTTPServerErrorLog(log *log.Logger) HTTPServerOption

+ func OptHTTPServerHandler(handler http.Handler) HTTPServerOption

+ func OptHTTPServerIdleTimeout(value time.Duration) HTTPServerOption

+ func OptHTTPServerMaxHeaderBytes(value int) HTTPServerOption

+ func OptHTTPServerReadHeaderTimeout(value time.Duration) HTTPServerOption

+ func OptHTTPServerReadTimeout(value time.Duration) HTTPServerOption

+ func OptHTTPServerTLSConfig(cfg *tls.Config) HTTPServerOption

+ func OptHTTPServerWriteTimeout(value time.Duration) HTTPServerOption

+ type HTTPTrace struct

+ ConnectDone time.Time

+ ConnectStart time.Time

+ DNSDone time.Time

+ DNSElapsed time.Duration

+ DNSStart time.Time

+ DialElapsed time.Duration

+ GetConn time.Time

+ GotConn time.Time

+ GotFirstResponseByte time.Time

+ PutIdleConn time.Time

+ RequestElapsed time.Duration

+ ServerElapsed time.Duration

+ TLSHandshakeDone time.Time

+ TLSHandshakeElapsed time.Duration

+ TLSHandshakeStart time.Time

+ WroteHeaders time.Time

+ WroteRequest time.Time

+ func (ht *HTTPTrace) Trace() *httptrace.ClientTrace

+ type HTTPTraceFinisher interface

+ Finish func(error)

+ type HTTPTracer interface

+ Start func(*http.Request) (HTTPTraceFinisher, *http.Request)

+ type Middleware func(http.HandlerFunc) http.HandlerFunc

+ func HTTPLogged(log logger.Triggerable) Middleware

+ type PostedFile struct

+ Contents []byte

+ FileName string

+ Key string

+ func PostedFiles(r *http.Request) ([]PostedFile, error)

+ type RequestOption func(*http.Request) error

+ func OptBasicAuth(username, password string) RequestOption

+ func OptBody(contents io.ReadCloser) RequestOption

+ func OptBodyBytes(body []byte) RequestOption

+ func OptContext(ctx context.Context) RequestOption

+ func OptCookie(cookie *http.Cookie) RequestOption

+ func OptCookieValue(key, value string) RequestOption

+ func OptDelete() RequestOption

+ func OptGet() RequestOption

+ func OptHeader(headers http.Header) RequestOption

+ func OptHeaderValue(key, value string) RequestOption

+ func OptJSONBody(obj interface{}) RequestOption

+ func OptMethod(method string) RequestOption

+ func OptPatch() RequestOption

+ func OptPost() RequestOption

+ func OptPostForm(postForm url.Values) RequestOption

+ func OptPostFormValue(key, value string) RequestOption

+ func OptPostedFiles(files ...PostedFile) RequestOption

+ func OptPut() RequestOption

+ func OptQuery(query url.Values) RequestOption

+ func OptQueryValue(key, value string) RequestOption

+ func OptXMLBody(obj interface{}) RequestOption

+ type RequestOptions []RequestOption

+ func (ro RequestOptions) Apply(req *http.Request) (err error)

+ type ResponseWriter interface

+ ContentLength func() int

+ InnerResponse func() http.ResponseWriter

+ StatusCode func() int

+ type StatusResponseWriter struct

+ func NewStatusResponseWriter(w http.ResponseWriter) *StatusResponseWriter

+ func (rw *StatusResponseWriter) Close() error

+ func (rw *StatusResponseWriter) ContentLength() int

+ func (rw *StatusResponseWriter) Flush()

+ func (rw *StatusResponseWriter) Header() http.Header

+ func (rw *StatusResponseWriter) Hijack() (net.Conn, *bufio.ReadWriter, error)

+ func (rw *StatusResponseWriter) InnerResponse() http.ResponseWriter

+ func (rw *StatusResponseWriter) StatusCode() int

+ func (rw *StatusResponseWriter) Write(b []byte) (int, error)

+ func (rw *StatusResponseWriter) WriteHeader(code int)

+ type TCPKeepAliveListener struct

+ KeepAlive bool

+ KeepAlivePeriod time.Duration

+ func (ln TCPKeepAliveListener) Accept() (c net.Conn, err error)

+ type Webhook struct

+ Body string

+ Headers map[string]string

+ Method string

+ URL string

+ func (wh Webhook) IsZero() bool

+ func (wh Webhook) MethodOrDefault() string

+ func (wh Webhook) Send() (*http.Response, error)

Feb 5, 2019

Changes in this version

+ const SchemeHTTP

+ const SchemeHTTPS

+ const SchemeSPDY

+ var HeaderForwarded = http.CanonicalHeaderKey("Forwarded")

+ var HeaderXForwardedFor = http.CanonicalHeaderKey("X-Forwarded-For")

+ var HeaderXForwardedHost = http.CanonicalHeaderKey("X-Forwarded-Host")

+ var HeaderXForwardedPort = http.CanonicalHeaderKey("X-Forwarded-Port")

+ var HeaderXForwardedProto = http.CanonicalHeaderKey("X-Forwarded-Proto")

+ var HeaderXForwardedScheme = http.CanonicalHeaderKey("X-Forwarded-Scheme")

+ var HeaderXRealIP = http.CanonicalHeaderKey("X-Real-IP")

+ func GetPort(r *http.Request) string

+ func HeaderLastValue(headers http.Header, key string) (string, bool)

+ type GracefulServer struct

+ func NewGracefulServer(server *http.Server) *GracefulServer

+ func (gs *GracefulServer) Listener() net.Listener

+ func (gs *GracefulServer) NotifyStarted() <-chan struct{}

+ func (gs *GracefulServer) NotifyStopped() <-chan struct{}

+ func (gs *GracefulServer) ShutdownGracePeriod() time.Duration

+ func (gs *GracefulServer) Start() (err error)

+ func (gs *GracefulServer) Stop() error

+ func (gs *GracefulServer) WithListener(l net.Listener) *GracefulServer

+ func (gs *GracefulServer) WithShutdownGracePeriod(d time.Duration) *GracefulServer

Oct 8, 2018

Changes in this version

+ func URLWithPort(u *url.URL, port string) *url.URL

+ func URLWithQuery(u *url.URL, key, value string) *url.URL

Oct 5, 2018

Changes in this version

+ const ConnectionKeepAlive

+ const ContentEncodingGZIP

+ const ContentEncodingIdentity

+ const ContentTypeApplicationJSON

+ const ContentTypeHTML

+ const ContentTypeText

+ const ContentTypeXML

+ const HeaderAcceptEncoding

+ const HeaderCacheControl

+ const HeaderConnection

+ const HeaderContentEncoding

+ const HeaderContentLength

+ const HeaderContentType

+ const HeaderCookie

+ const HeaderDate

+ const HeaderServer

+ const HeaderSetCookie

+ const HeaderStrictTransportSecurity

+ const HeaderUserAgent

+ const HeaderVary

+ const HeaderXContentTypeOptions

+ const HeaderXFrameOptions

+ const HeaderXServedBy

+ const HeaderXXSSProtection

+ var DefaultRequestMethod = "POST"

+ var DefaultRequestTimeout = 10 * time.Second

+ var ErrURLUnset = exception.Class("request url unset")

+ func DeserializeReaderAsJSON(object interface{}, body io.ReadCloser) error

+ func GetHost(r *http.Request) string

+ func GetProto(r *http.Request) string

+ func GetRemoteAddr(r *http.Request) string

+ func GetUserAgent(r *http.Request) string

+ func LocalIP() string

+ func MustParseURL(rawURL string) *url.URL

+ func NewMockRequest(method, path string) *http.Request

+ func NewMockRequestWithCookie(method, path, cookieName, cookieValue string) *http.Request

+ func PortFromBindAddr(bindAddr string) (port int32)

+ func URLWithHost(u *url.URL, host string) *url.URL

+ func URLWithPath(u *url.URL, path string) *url.URL

+ func URLWithRawQuery(u *url.URL, rawQuery string) *url.URL

+ func URLWithScheme(u *url.URL, scheme string) *url.URL

+ func WriteJSON(w http.ResponseWriter, statusCode int, response interface{}) error

+ func WriteNoContent(w http.ResponseWriter) error

+ func WriteRawContent(w http.ResponseWriter, statusCode int, content []byte) error

+ func WriteXML(w http.ResponseWriter, statusCode int, response interface{}) error

+ type MockResponseWriter struct

+ func NewMockResponse(buffer io.Writer) *MockResponseWriter

+ func (res *MockResponseWriter) Bytes() []byte

+ func (res *MockResponseWriter) Close() error

+ func (res *MockResponseWriter) ContentLength() int

+ func (res *MockResponseWriter) Flush() error

+ func (res *MockResponseWriter) Header() http.Header

+ func (res *MockResponseWriter) InnerResponse() http.ResponseWriter

+ func (res *MockResponseWriter) StatusCode() int

+ func (res *MockResponseWriter) Write(buffer []byte) (int, error)

+ func (res *MockResponseWriter) WriteHeader(statusCode int)

+ type RequestSender struct

+ func NewRequestSender(destination *url.URL) *RequestSender

+ func (rs *RequestSender) Client() *http.Client

+ func (rs *RequestSender) Close() bool

+ func (rs *RequestSender) Headers() http.Header

+ func (rs *RequestSender) Method() string

+ func (rs *RequestSender) Send() (*http.Response, error)

+ func (rs *RequestSender) SendBytes(ctx context.Context, contents []byte) (*http.Response, error)

+ func (rs *RequestSender) SendJSON(ctx context.Context, contents interface{}) (*http.Response, error)

+ func (rs *RequestSender) Tracer() RequestTracer

+ func (rs *RequestSender) Transport() *http.Transport

+ func (rs *RequestSender) WithClose(close bool) *RequestSender

+ func (rs *RequestSender) WithHeader(key, value string) *RequestSender

+ func (rs *RequestSender) WithHeaders(headers http.Header) *RequestSender

+ func (rs *RequestSender) WithMethod(method string) *RequestSender

+ func (rs *RequestSender) WithTracer(tracer RequestTracer) *RequestSender

+ func (rs *RequestSender) WithTransport(transport *http.Transport) *RequestSender

+ type RequestTraceFinisher interface

+ Finish func(*http.Request, *http.Response, error)

+ type RequestTracer interface

+ Start func(*http.Request) RequestTraceFinisher