req_interface_gen.go

// Code generated by ifacemaker; DO NOT EDIT.

package fiber

import (
	"io"
	"mime/multipart"
	"time"

	"github.com/valyala/fasthttp"
)

// Req is an interface for request-related Ctx methods.
type Req interface {
	// Accepts checks if the specified extensions or content types are acceptable.
	Accepts(offers ...string) string
	// AcceptsCharsets checks if the specified charset is acceptable.
	AcceptsCharsets(offers ...string) string
	// AcceptsEncodings checks if the specified encoding is acceptable.
	//
	// Per RFC 9110 §12.5.3, a missing Accept-Encoding accepts any coding (the first
	// offer wins), an empty one only "identity", and "identity" is acceptable unless
	// the field excludes it with q=0.
	AcceptsEncodings(offers ...string) string
	// AcceptsLanguages checks if the specified language is acceptable using
	// RFC 4647 Basic Filtering.
	AcceptsLanguages(offers ...string) string
	// AcceptsLanguagesExtended checks if the specified language is acceptable using
	// RFC 4647 Extended Filtering.
	AcceptsLanguagesExtended(offers ...string) string
	// App returns the *App reference to the instance of the Fiber application
	App() *App
	// BaseURL returns (protocol + host), such as "https://example.com". It carries no path.
	BaseURL() string
	// BodyRaw contains the raw body submitted in a POST request.
	// Returned value is only valid within the handler. Do not store any references.
	// Make copies or use the Immutable setting instead.
	BodyRaw() []byte
	//nolint:nonamedreturns // gocritic unnamedResult prefers naming decoded body, decode count, and error
	tryDecodeBodyInOrder(originalBody *[]byte, encodings []string) (body []byte, decodesRealized uint8, err error)
	// Body contains the raw body submitted in a POST request.
	// This method will decompress the body if the 'Content-Encoding' header is provided.
	// It returns the original (or decompressed) body data which is valid only within the handler.
	// Don't store direct references to the returned data.
	// If you need to keep the body's data later, make a copy or use the Immutable option.
	Body() []byte
	// BodyStream returns the request body as a stream, non-nil only when
	// Config.StreamRequestBody is enabled and the body is not already buffered.
	// Reading it consumes the body, so a later Body call will not see it.
	BodyStream() io.Reader
	// ContentLength returns the value of the Content-Length request header. A
	// negative result is not a length: -1 is chunked and -2 is identity, which is
	// what a bodyless GET reports. Use HasBody to test for a body at all.
	ContentLength() int
	// RequestCtx returns *fasthttp.RequestCtx that carries a deadline
	// a cancellation signal, and other values across API boundaries.
	RequestCtx() *fasthttp.RequestCtx
	// FullURL returns the full request URL (protocol + host + original URL).
	FullURL() string
	// UserAgent returns the User-Agent request header.
	UserAgent() string
	// Referer returns the Referer request header.
	Referer() string
	// Origin returns the Origin request header.
	// Returned value is only valid within the handler. Do not store any references.
	// Make copies or use the Immutable setting to use the value outside the Handler.
	Origin() string
	// headerField returns a request header's first non-empty field value, matching
	// the field name case-insensitively (RFC 9110 Section 5.1). fieldname.First
	// also steps over a present-but-empty first line, so a value on a later line
	// is found and this agrees with GetAll on whether the field is there.
	headerField(name string) []byte
	// AcceptLanguage returns the Accept-Language request header.
	// Repeated field lines are combined into one comma-joined list (RFC 9110
	// Section 5.2) and the field name matches case-insensitively (Section 5.1),
	// matching what AcceptsLanguages negotiates on.
	AcceptLanguage() string
	// AcceptEncoding returns the Accept-Encoding request header.
	// Repeated field lines are combined into one comma-joined list (RFC 9110
	// Section 5.2) and the field name matches case-insensitively (Section 5.1),
	// matching what AcceptsEncodings negotiates on.
	AcceptEncoding() string
	// HasHeader reports whether the request includes a header with the given key.
	// The field name matches case-insensitively (RFC 9110 Section 5.1), so this
	// agrees with GetAll on whether the field is there.
	HasHeader(key string) bool
	// HasHeaderValue reports whether the request header key lists value as one of
	// its comma-separated members, on any of its field lines. Repeated field lines
	// are one list (RFC 9110 Section 5.3) and the member matches under ASCII case
	// folding, so it fits directive-style headers such as Cache-Control or
	// Connection. A comma inside a quoted argument does not end a member, so
	// `ext="a,no-transform,b"` is one member and does not list no-transform
	// (RFC 9111 permits quoted directive arguments, escaped quotes included). An
	// empty value is never present. Only valid within the handler.
	HasHeaderValue(key, value string) bool
	// ContentType returns the Content-Type request header, parameters included;
	// MediaType strips them and Charset returns just the charset. On Ctx the request
	// wins over Res. Only valid within the handler unless Immutable is set.
	ContentType() string
	// MediaType returns the MIME type from the Content-Type header without parameters.
	MediaType() string
	// Charset returns the charset parameter from the Content-Type header.
	Charset() string
	// IsJSON reports whether the Content-Type header is JSON.
	IsJSON() bool
	// IsForm reports whether the Content-Type header is form-encoded.
	IsForm() bool
	// IsMultipart reports whether the Content-Type header is multipart form data.
	IsMultipart() bool
	// AcceptsJSON reports whether the Accept header allows JSON.
	AcceptsJSON() bool
	// AcceptsHTML reports whether the Accept header allows HTML.
	AcceptsHTML() bool
	// AcceptsXML reports whether the Accept header allows XML.
	AcceptsXML() bool
	// AcceptsEventStream reports whether the Accept header allows text/event-stream.
	AcceptsEventStream() bool
	// Cookies are used for getting a cookie value by key.
	// Defaults to the empty string "" if the cookie doesn't exist.
	// If a default value is given, it will return that value if the cookie doesn't exist.
	// The returned value is only valid within the handler. Do not store any references.
	// Make copies or use the Immutable setting to use the value outside the Handler.
	Cookies(key string, defaultValue ...string) string
	// CookieNames returns the request cookie names in header order, or nil when
	// there are none. A repeated name appears once per occurrence, which is how the
	// shadowing AllCookies collapses is detected. The strings are copies.
	CookieNames() []string
	// AllCookies returns the request cookies as a name/value map, or nil when there
	// are none. A repeated name resolves to its first occurrence, as Cookies does,
	// so a shadowed cookie cannot be validated in one and consumed in the other.
	AllCookies() map[string]string
	// Request return the *fasthttp.Request object
	// This allows you to use all fasthttp request methods
	// https://godoc.org/github.com/valyala/fasthttp#Request
	Request() *fasthttp.Request
	// FormFile returns the first file by key from a MultipartForm.
	// The multipart form is parsed using the application's BodyLimit to prevent
	// unbounded memory usage.
	FormFile(key string) (*multipart.FileHeader, error)
	// FormValue returns the first value by key from a MultipartForm.
	// Search is performed in QueryArgs, PostArgs, MultipartForm and FormFile in this particular order.
	// Defaults to the empty string "" if the form value doesn't exist.
	// If a default value is given, it will return that value if the form value does not exist.
	// Returned value is only valid within the handler. Do not store any references.
	// Make copies or use the Immutable setting instead.
	// When the request is a multipart form, it is parsed using the application's
	// BodyLimit so the configured limit is consistently enforced.
	//
	// On a form request this lowercases the case-insensitive parts of the request's
	// own Content-Type, so a value obtained earlier from Get(HeaderContentType) —
	// which aliases those bytes unless Immutable is set — can change during the
	// call. Copy it first if you need it to outlive one.
	FormValue(key string, defaultValue ...string) string
	// Fresh returns true when the response is still “fresh” in the client's cache,
	// otherwise false is returned to indicate that the client cache is now stale
	// and the full response should be sent.
	// Freshness only applies to GET and HEAD requests; for any other method false is
	// returned, as RFC 9110 defines 304 Not Modified only for those methods and
	// requires If-Modified-Since to be ignored otherwise.
	// When a client sends the Cache-Control: no-cache request header to indicate an end-to-end
	// reload request, this module will return false to make handling these requests transparent.
	// https://github.com/jshttp/fresh/blob/master/index.js#L33
	Fresh() bool
	// IfNoneMatch returns the entity tags in the If-None-Match request header,
	// verbatim and unvalidated; a comma inside a quoted opaque-tag does not split
	// one. Fresh already compares them. Only valid within the handler.
	IfNoneMatch() []string
	// IfModifiedSince returns the time carried by the If-Modified-Since request
	// header, ErrHeaderNotFound when it is absent or empty, and a parse error when
	// it is none of the HTTP-date formats RFC 9110 Section 5.6.7 requires.
	IfModifiedSince() (time.Time, error)
	// Get returns the HTTP request header specified by field.
	// Field names are case-insensitive
	// Returned value is only valid within the handler. Do not store any references.
	// Make copies or use the Immutable setting instead.
	Get(key string, defaultValue ...string) string
	// GetAll returns every field line stored under key, where Get returns only the
	// first, or nil when the header is absent. Empty lines are skipped, so its
	// presence answers as HasHeader does. Only valid within the handler.
	GetAll(key string) []string
	// Authorization splits the Authorization header into auth-scheme and credentials
	// (RFC 9110 Section 11.6.2), neither decoded nor validated. They view the request
	// buffer: a credential kept past the handler becomes another request's.
	Authorization() (scheme, credentials string)
	// authorizationParts splits the Authorization header at the first space or tab
	// (RFC 9110 Section 11.4), on raw bytes so each caller materializes only the
	// strings it needs. A lone token is a scheme without credentials.
	authorizationParts() (scheme, credentials []byte)
	// Bearer returns the credentials of a Bearer Authorization header (RFC 6750
	// Section 2.1), unverified, or "" for another scheme. It views the request
	// buffer: a token kept past the handler becomes another request's.
	Bearer() string
	// GetHeaders (a.k.a GetReqHeaders) returns the HTTP request headers.
	// Returned value is only valid within the handler. Do not store any references.
	// Make copies or use the Immutable setting instead.
	GetHeaders() map[string][]string
	// Host contains the host derived from the X-Forwarded-Host or Host HTTP header.
	// Returned value is only valid within the handler. Do not store any references.
	// In a network context, `Host` refers to the combination of a hostname and potentially a port number used for connecting,
	// while `Hostname` refers specifically to the name assigned to a device on a network, excluding any port information.
	// Example: URL: https://example.com:8080 -> Host: example.com:8080
	// Make copies or use the Immutable setting instead.
	// Please use Config.TrustProxy to prevent header spoofing if your app is behind a proxy.
	Host() string
	// Hostname contains the hostname derived from the X-Forwarded-Host or Host HTTP header using the c.Host() method.
	// Returned value is only valid within the handler. Do not store any references.
	// Example: URL: https://example.com:8080 -> Hostname: example.com
	// Make copies or use the Immutable setting instead.
	// Please use Config.TrustProxy to prevent header spoofing if your app is behind a proxy.
	Hostname() string
	// Port returns the remote port of the request.
	Port() string
	// IP returns the client's IP address. When the request comes from a trusted proxy (see
	// [TrustProxyConfig]) and Config.ProxyHeader is set, the value is taken from that header.
	// With Config.EnableIPValidation enabled and proxy IPs or ranges configured (Proxies,
	// Loopback, Private or LinkLocal), the X-Forwarded-For chain is walked right-to-left, every
	// trusted proxy IP is skipped and the first non-trusted IP is returned; with validation
	// enabled but only UnixSocket trusted, the first valid IP from the left is returned. With
	// validation disabled (the default), the raw header value is returned as-is, which for
	// X-Forwarded-For may be the whole comma-separated chain. Enable validation whenever the
	// result is used as a single client identifier and the header can carry a chain, for example
	// by the limiter middleware or an allowlist; a proxy that overwrites the header with one
	// address, or a single-IP header, does not need it. Please use Config.TrustProxy to prevent
	// header spoofing if your app is behind a proxy.
	IP() string
	// extractIPsFromHeader will return a slice of IPs it found given a header name in the order they appear.
	// When IP validation is enabled, any invalid IPs will be omitted.
	extractIPsFromHeader(header string) []string
	// extractIPFromHeader returns the client IP from the given proxy header by walking the
	// X-Forwarded-For chain from right to left and stripping trusted proxy IPs. When trusted
	// proxies are configured, the rightmost non-trusted IP is returned; otherwise the first
	// valid IP (left-to-right) is returned. When IP validation is disabled, the raw header
	// value is returned as-is.
	extractIPFromHeader(header string) string
	// hasTrustedProxyConfig returns true if any trusted proxy configuration is set.
	hasTrustedProxyConfig() bool
	// isTrustedProxyIP checks whether the given IP string matches any configured trusted proxy.
	isTrustedProxyIP(ipStr string) bool
	// IPs returns a string slice of IP addresses specified in the X-Forwarded-For request header.
	// When IP validation is enabled, only valid IPs are returned.
	IPs() []string
	// Is returns the matching content type,
	// if the incoming request's Content-Type HTTP header field matches the MIME type specified by the type parameter
	Is(extension string) bool
	// HasBody returns true if the request declares a body via Content-Length, Transfer-Encoding, or already buffered payload data.
	HasBody() bool
	// IsWebSocket returns true if the request includes a WebSocket upgrade handshake.
	IsWebSocket() bool
	// IsPreflight returns true if the request is a CORS preflight.
	IsPreflight() bool
	// Secure returns whether a secure connection was established.
	Secure() bool
	// XHR returns a Boolean property, that is true, if the request's X-Requested-With header field is XMLHttpRequest,
	// indicating that the request was issued by a client library (such as jQuery).
	XHR() bool
	// Locals makes it possible to pass any values under keys scoped to the request
	// and therefore available to all following routes that match the request.
	//
	// All the values are removed from ctx after returning from the top
	// RequestHandler. Additionally, Close method is called on each value
	// implementing io.Closer before removing the value from ctx.
	//
	// Storing through the Ctx interface heap-allocates the one-element slice the
	// variadic value is packed into; SetLocal stores the same value without it.
	Locals(key any, value ...any) any
	// SetLocal stores value under key scoped to the request, exactly as
	// Locals(key, value) does: the value is available to all following routes that
	// match the request, removed after the top RequestHandler returns, and its
	// Close method is called first if it implements io.Closer. Like Locals, it
	// stores nothing while the context is released. A Ctx must not be used past
	// its handler either way, because the pool hands the same one to the next
	// request.
	//
	// Locals takes its value variadically, and reached through the Ctx interface
	// the compiler cannot see that the callee only reads that argument, so the
	// one-element "..." slice is heap-allocated on every call. SetLocal takes the
	// value directly, so that slice is never built. Boxing a value that is not
	// already an interface still allocates, exactly as it does for Locals.
	SetLocal(key, value any)
	// Method returns the HTTP request method for the context, optionally overridden by the provided argument.
	// If no override is given or if the provided override is not a valid HTTP method, it returns the current method from the context.
	// Otherwise, it updates the context's method and returns the overridden method as a string.
	Method(override ...string) string
	// IsSafe reports whether the request method is safe, meaning it is not expected
	// to change server state (RFC 9110 Section 9.2.1).
	IsSafe() bool
	// IsIdempotent reports whether the request method is idempotent, meaning
	// repeating it has the same intended effect as making it once (RFC 9110
	// Section 9.2.2). Every safe method is also idempotent.
	IsIdempotent() bool
	// MultipartForm parse form entries from binary.
	// This returns a map[string][]string, so given a key, the value will be a string slice.
	//
	// On a form request this lowercases the case-insensitive parts of the request's
	// own Content-Type, so a value obtained earlier from Get(HeaderContentType) —
	// which aliases those bytes unless Immutable is set — can change during the
	// call. Copy it first if you need it to outlive one.
	MultipartForm() (*multipart.Form, error)
	// OriginalURL contains the original request URL.
	// Returned value is only valid within the handler. Do not store any references.
	// Make copies or use the Immutable setting to use the value outside the Handler.
	OriginalURL() string
	// URI returns the parsed *fasthttp.URI of the request, giving access to all
	// fasthttp URI methods. It is owned by the request and rewritten by a Path
	// override, so it is only valid within the handler.
	URI() *fasthttp.URI
	// Path returns the path part of the request URL, normalized before routing
	// (see Config.UnescapePath); OriginalURL returns the request target as sent.
	// Optionally, you could override the path.
	// Make copies or use the Immutable setting to use the value outside the Handler.
	Path(override ...string) string
	// Params is used to get the route parameters.
	// Defaults to empty string "" if the param doesn't exist.
	// If a default value is given, it will return that value if the param doesn't exist.
	// Returned value is only valid within the handler. Do not store any references.
	// Make copies or use the Immutable setting to use the value outside the Handler.
	Params(key string, defaultValue ...string) string
	// Scheme contains the request protocol string: http or https for TLS requests.
	// Please use Config.TrustProxy to prevent header spoofing if your app is behind a proxy.
	Scheme() string
	// Protocol returns the HTTP protocol of request: HTTP/1.1 and HTTP/2.
	Protocol() string
	// Query returns the query string parameter in the url.
	// Defaults to empty string "" if the query doesn't exist.
	// If a default value is given, it will return that value if the query doesn't exist.
	// Returned value is only valid within the handler. Do not store any references.
	// Make copies or use the Immutable setting to use the value outside the Handler.
	Query(key string, defaultValue ...string) string
	// Queries returns a map of query parameters and their values.
	//
	// GET /?name=alex&wanna_cake=2&id=
	// Queries()["name"] == "alex"
	// Queries()["wanna_cake"] == "2"
	// Queries()["id"] == ""
	//
	// GET /?field1=value1&field1=value2&field2=value3
	// Queries()["field1"] == "value2"
	// Queries()["field2"] == "value3"
	//
	// GET /?list_a=1&list_a=2&list_a=3&list_b[]=1&list_b[]=2&list_b[]=3&list_c=1,2,3
	// Queries()["list_a"] == "3"
	// Queries()["list_b[]"] == "3"
	// Queries()["list_c"] == "1,2,3"
	//
	// GET /api/search?filters.author.name=John&filters.category.name=Technology&filters[customer][name]=Alice&filters[status]=pending
	// Queries()["filters.author.name"] == "John"
	// Queries()["filters.category.name"] == "Technology"
	// Queries()["filters[customer][name]"] == "Alice"
	// Queries()["filters[status]"] == "pending"
	Queries() map[string]string
	// Range returns a struct containing the type and a slice of ranges.
	Range(size int64) (Range, error)
	// Endpoint returns the route that will handle this request. See Ctx.Endpoint.
	Endpoint() *Route
	// Route returns the matched Route struct.
	Route() *Route
	// Subdomains returns a slice of subdomains from the host, excluding the last `offset` components.
	// If the offset is negative or exceeds the number of subdomains, an empty slice is returned.
	// If the offset is zero every label (no trimming) is returned.
	Subdomains(offset ...int) []string
	// Stale returns the inverse of Fresh, indicating if the client's cached response is considered stale.
	Stale() bool
	// IsProxyTrusted checks trustworthiness of remote ip.
	// If Config.TrustProxy false, it returns false.
	// IsProxyTrusted can check remote ip by proxy ranges and ip map.
	IsProxyTrusted() bool
	// IsFromLocal will return true if request came from a loopback IP.
	IsFromLocal() bool
	// IsFromUnixSocket returns true if the request arrived over a Unix domain socket.
	IsFromUnixSocket() bool
	getBody() []byte
}