Request

Topics

Structures

• struct Authentication
  Request helper for storing and fetching authenticated objects.
• struct Body
• struct Password
• struct Services

Initializers

• convenience init(application: Application, method: HTTPMethod, url: URI, version: HTTPVersion, headers: HTTPHeaders, collectedBody: ByteBuffer?, remoteAddress: SocketAddress?, logger: Logger, byteBufferAllocator: ByteBufferAllocator, on: any EventLoop)
• convenience init(application: Application, method: HTTPMethod, url: URI, version: HTTPVersion, headers: HTTPHeaders, collectedBody: ByteBuffer?, remoteAddress: SocketAddress?, peerCertificateChain: ValidatedCertificateChain?, logger: Logger, byteBufferAllocator: ByteBufferAllocator, on: any EventLoop)
• convenience init(application: Application, method: HTTPMethod, url: URI, version: HTTPVersion, headersNoUpdate: HTTPHeaders, collectedBody: ByteBuffer?, remoteAddress: SocketAddress?, logger: Logger, byteBufferAllocator: ByteBufferAllocator, on: any EventLoop)
• init(application: Application, method: HTTPMethod, url: URI, version: HTTPVersion, headersNoUpdate: HTTPHeaders, collectedBody: ByteBuffer?, remoteAddress: SocketAddress?, peerCertificateChain: ValidatedCertificateChain?, logger: Logger, byteBufferAllocator: ByteBufferAllocator, on: any EventLoop)

Instance Properties

• let application: Application
• var auth: Request.Authentication
  Helper for accessing authenticated objects. See Authenticator for more information.
• var body: Request.Body
• var byteBufferAllocator: ByteBufferAllocator
• var cache: any Cache
• var client: any Client
• 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
  See CustomStringConvertible
• let eventLoop: any EventLoop
  The EventLoop which is handling this Request. The route handler and any relevant middleware are invoked in this event loop.
• var fileio: FileIO
• var hasSession: Bool
• var headers: HTTPHeaders
  The header fields for this HTTP request. The "Content-Length" and "Transfer-Encoding" headers will be set automatically when the body property is mutated.
• let id: String
  A unique ID for the request.
• var logger: Logger
  This Logger from Apple’s swift-log Package is preferred when logging in the context of handing this Request. Vapor already provides metadata to this logger so that multiple logged messages can be traced back to the same request.
• var method: HTTPMethod
  The HTTP method for this request.
• var 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 password: Request.Password
• var peerAddress: SocketAddress?
  We try to determine true peer address if load balancer or reversed proxy provided info in headers
• var peerCertificateChain: ValidatedCertificateChain?
  The validated certificate chain. This returns nil if the peer did not authenticate with a certificate. Requires configuring a customCertificateVerifyCallbackWithMetadata that performs the verification.
• var query: any URLQueryContainer
• 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.
• var route: Route?
  Route object we found for this request. This holds metadata that can be used for (for example) Metrics.
• var serviceContext: ServiceContext
• var services: Request.Services
• var session: Session
  Returns the current Session or creates one.
• var storage: Storage
  This container is used as arbitrary request-local storage during the request-response lifecycle.Z
• var url: URI
  The URL used on this request.
• var version: HTTPVersion
  The version for this HTTP request.
• var view: any ViewRenderer

Instance Methods

• func redirect(to: String, redirectType: Redirect) -> Response
  Creates a redirect Response.
• func redirect(to: String, type: RedirectType) -> Response
  Creates a redirect Response.
• func webSocket(maxFrameSize:shouldUpgrade:onUpgrade:)

Default Implementations

• AsyncRequestDecodable Implementations
• RequestDecodable Implementations