Request

Topics

Classes

• class Authentication
  Stores and fetches the instances authenticated for a request.

Structures

• struct Body
  A view onto this request’s body.

Initializers

• init(method: HTTPRequest.Method, url: URI, version: HTTPVersion, headers: HTTPFields, collectedBody: Data?, remoteAddress: SocketAddress?, localAddress: SocketAddress?, peerCertificateChain: ValidatedCertificateChain?, requestID: String, contentConfiguration: ContentConfiguration, defaultMaxBodySize: ByteCount)

Instance Properties

• let auth: Authentication
  Authentication storage for the request
• var body: Body
  The request body, as a non-escapable view bound to this request value (see Request.Body).
• var content: any ContentContainer
  This container is used to read your Decodable type using a ContentDecoder implementation. If no ContentDecoder is provided, a Request’s Content-Type header is used to select a registered decoder.
• var cookies: HTTPCookies
  Get and set HTTPCookies for this Request This accesses the "Cookie" header.
• var description: String
• var hasSession: Bool
• var headers: HTTPFields
  The header fields for this HTTP request.
• let id: String
  A unique ID for the request.
• let localAddress: SocketAddress?
  The address the request was received on
• var maxBodySize: ByteCount
  The most bytes this request’s body may be buffered into by collect(max:) or by decoding its content.
• let method: HTTPRequest.Method
  The HTTP method for this request.
• let parameters: Parameters
  A container containing the route parameters that were captured when receiving this request. Use this container to grab any non-static parameters from the URL, such as model IDs in a REST API.
• var peerAddress: SocketAddress?
  We try to determine true peer address if load balancer or reversed proxy provided info in headers
• let peerCertificateChain: ValidatedCertificateChain?
  The client’s verified certificate chain, or nil if it presented none.
• var query: any URLQueryContainer
  This container is used to read and write the request’s query string. Changes (e.g. via req.query.encode) are written back to the request
• let remoteAddress: SocketAddress?
  The address from which this HTTP request was received by SwiftNIO. This address may not represent the original address of the peer, especially if Vapor receives its requests through a reverse-proxy such as nginx.
• let route: Route?
  Route object we found for this request. This holds metadata that can be used for (for example) Metrics.
• var session: Session
  Returns the current Session or creates one.
• var url: URI
  The URL used on this request.
• let version: HTTPVersion
  The version for this HTTP request.

Instance Methods

• func redirect(to: String, redirectType: Redirect) -> Response
  Creates a redirect Response.

Default Implementations

• RequestDecodable Implementations