package httpcommon

Import Path
	net/http/internal/httpcommon (on go.dev)

Dependency Relation
	imports 12 packages, and imported by one package

Involved Source Files

	    httpcommon.go
Package-Level Type Names (total 5)

	/* sort by: alphabet | popularity */
	 type EncodeHeadersParam (struct)
		EncodeHeadersParam is parameters to EncodeHeaders.

		Fields (total 4)
			AddGzipHeader bool
				AddGzipHeader indicates that an "accept-encoding: gzip" header should be
				added to the request.

			DefaultUserAgent string
				DefaultUserAgent is the User-Agent header to send when the request
				neither contains a User-Agent nor disables it.

			PeerMaxHeaderListSize uint64
				PeerMaxHeaderListSize, when non-zero, is the peer's MAX_HEADER_LIST_SIZE setting.

			Request Request
		As Inputs Of (at least one exported)
			func EncodeHeaders(ctx context.Context, param EncodeHeadersParam, headerf func(name, value string)) (res EncodeHeadersResult, _ error)

	 type EncodeHeadersResult (struct)
		EncodeHeadersParam is the result of EncodeHeaders.

		Fields (total 2)
			HasBody bool
			HasTrailers bool
		As Outputs Of (at least one exported)
			func EncodeHeaders(ctx context.Context, param EncodeHeadersParam, headerf func(name, value string)) (res EncodeHeadersResult, _ error)

	 type Request (struct)
		Request is a subset of http.Request.
		It'd be simpler to pass an *http.Request, of course, but we can't depend on net/http
		without creating a dependency cycle.

		Fields (total 6)
			ActualContentLength int64
				// 0 means 0, -1 means unknown

			Header map[string][]string
			Host string
			Method string
			Trailer map[string][]string
			URL *url.URL

	 type ServerRequestParam (struct)
		ServerRequestParam is parameters to NewServerRequest.

		Fields (total 6)
			Authority string
			Header map[string][]string
			Method string
			Path string
			Protocol string
			Scheme string
		As Inputs Of (at least one exported)
			func NewServerRequest(rp ServerRequestParam) ServerRequestResult

	 type ServerRequestResult (struct)
		ServerRequestResult is the result of NewServerRequest.

		Fields (total 5)
			InvalidReason string
				If the request should be rejected, this is a short string suitable for passing
				to the http2 package's CountError function.
				It might be a bit odd to return errors this way rather than returing an error,
				but this ensures we don't forget to include a CountError reason.

			NeedsContinue bool
				// client provided an "Expect: 100-continue" header

			RequestURI string
			Trailer map[string][]string
			URL *url.URL
				Various http.Request fields.

		As Outputs Of (at least one exported)
			func NewServerRequest(rp ServerRequestParam) ServerRequestResult


Package-Level Functions (total 6)

	 func CachedCanonicalHeader(v string) (string, bool)
		CachedCanonicalHeader returns the canonical form of a well-known header name.

	 func CanonicalHeader(v string) string
		CanonicalHeader canonicalizes a header name. (For example, "host" becomes "Host".)

	 func EncodeHeaders(ctx context.Context, param EncodeHeadersParam, headerf func(name, value string)) (res EncodeHeadersResult, _ error)
		EncodeHeaders constructs request headers common to HTTP/2 and HTTP/3.
		It validates a request and calls headerf with each pseudo-header and header
		for the request.
		The headerf function is called with the validated, canonicalized header name.

	 func IsRequestGzip(method string, header map[string][]string, disableCompression bool) bool
		IsRequestGzip reports whether we should add an Accept-Encoding: gzip header
		for a request.

	 func LowerHeader(v string) (lower string, ascii bool)
		LowerHeader returns the lowercase form of a header name,
		used on the wire for HTTP/2 and HTTP/3 requests.

	 func NewServerRequest(rp ServerRequestParam) ServerRequestResult
Package-Level Variables (only one)

	  var ErrRequestHeaderListSize error

The pages are generated with Golds v0.7.7-preview. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.