Vapor

Topics

Classes

• Application
  Core type representing a Vapor application.
• BCryptDigest
  Creates and verifies BCrypt hashes. Normally you will not need to initialize one of these classes and you will use the global BCrypt convenience instead.
• BootCommand
  Boots the Application then exits successfully.
• CORSMiddleware
  Middleware that adds support for CORS settings in request responses. For configuration of this middleware please use the CORSMiddleware.Configuration object.
• EndpointCache
  Handles the complexities of HTTP caching.
• ErrorMiddleware
  Captures all errors and transforms them into an internal server error HTTP response.
• FileMiddleware
  Serves static files from a public directory.
• HTTPServer
• Request
  Represents an HTTP request in an application.
• Response
  An HTTP response from a server back to the client.
• Route
• RouteLoggingMiddleware
  Emits a log message containing the request method and path to a Request’s logger. The log level of the message is configurable.
• Routes
• RoutesCommand
  Displays all routes registered to the Application’s Router in an ASCII-formatted table.
• ServeCommand
  Boots the application’s server. Listens for SIGINT and SIGTERM for graceful shutdown.
• Session
  Sessions are a method for associating data with a client accessing your app.
• SessionsMiddleware
  Uses HTTP cookies to save and restore sessions for connecting clients.
• TracingMiddleware
  Creates a trace and metadata for every request

Protocols

• AbortError
  Errors conforming to this protocol will always be displayed by Vapor to the end-user (even in production mode where most errors are silenced).
• AnyOptionalType
  Type-erased OptionalType
• AsyncAuthenticator
  Helper for creating authentication middleware.
• AsyncBasicAuthenticator
  Helper for creating authentication middleware using the Basic authorization header.
• AsyncBearerAuthenticator
  Helper for creating authentication middleware using the Bearer authorization header.
• AsyncBodyStreamWriter
  A type that represents the writable handle of a streamed Response body
• AsyncCredentialsAuthenticator
  Helper for creating authentication middleware using request body contents.
• AsyncMiddleware
  AsyncMiddleware is placed between the server and your router. It is capable of mutating both incoming requests and outgoing responses. AsyncMiddleware can choose to pass requests on to the next AsyncMiddleware in a chain, or they can short circuit and return a custom Response if desired.
• AsyncRequestAuthenticator
  Help for creating authentication middleware based on Request.
• AsyncRequestDecodable
  Can convert Request to a Self.
• AsyncResponder
• AsyncResponseEncodable
  Can convert self to a Response.
• AsyncSessionAuthenticator
  Helper for creating authentication middleware in conjunction with SessionsMiddleware.
• AsyncSessionDriver
  Capable of managing CRUD operations for Sessions.
• Authenticatable
  Capable of being authenticated.
• Authenticator
  Helper for creating authentication middleware.
• BasicAuthenticator
  Helper for creating authentication middleware using the Basic authorization header.
• BearerAuthenticator
  Helper for creating authentication middleware using the Bearer authorization header.
• BodyStreamWriter
  A type that represents the writable handle of a streamed Response body.
• Cache
  Codable key-value pair cache.
• Client
• CodingKeyRepresentable
  This is an unwelcome stand-in for the Swift/CodingKeyRepresentable protocol that appeared in Swift 5.6.
• Content
  Convertible to / from content in an HTTP message.
• ContentContainer
• ContentDecoder
  Conform a type to this protocol to make it usable for decoding data via Vapor’s ContentConfiguration system.
• ContentEncoder
  Conform a type to this protocol to make it usable for encoding data via Vapor’s ContentConfiguration system.
• CredentialsAuthenticator
  Helper for creating authentication middleware using request body contents.
• DebuggableError
  Debuggable provides an interface that allows a type to be more easily debugged in the case of an error.
• Extendable
  Types conforming to Extendable can have stored properties added in extension by using the Extend struct.
• LifecycleHandler
  Provides a way to hook into lifecycle events of a Vapor application. You can register your handlers with the Application to be notified when the application is about to start up, has started up and is about to shutdown
• LockKey
• Middleware
  Middleware is placed between the server and your router. It is capable of mutating both incoming requests and outgoing responses. Middleware can choose to pass requests on to the next Middleware in a chain, or they can short circuit and return a custom Response if desired.
• OptionalType
  Capable of being represented by an optional wrapped type.
• PasswordHasher
• RequestAuthenticator
  Help for creating authentication middleware based on Request.
• RequestDecodable
  Can convert Request to a Self.
• Responder
• ResponseEncodable
  Can convert self to a Response.
• RouteCollection
  Groups collections of routes together for adding to a router.
• RoutesBuilder
• Server
• SessionAuthenticatable
  Models conforming to this protocol can have their authentication status cached using SessionAuthenticator.
• SessionAuthenticator
  Helper for creating authentication middleware in conjunction with SessionsMiddleware.
• SessionDriver
  Capable of managing CRUD operations for Sessions.
• StorageKey
  A key used to store values in a Storage must conform to this protocol.
• URLQueryContainer
  Helper for encoding and decoding data from an HTTP request query string.
• URLQueryDecoder
• URLQueryEncoder
• Upgrader
  Conformance for any struct that performs an HTTP Upgrade
• Validatable
  Capable of being validated. Conformance adds a throwing validate() method.
• ValidatorResult
• ViewRenderer

Structures

• Abort
  Default implementation of AbortError. You can use this as a convenient method for throwing AbortErrors without having to conform your own error-type to AbortError.
• AnyAsyncResponse
  A type erased response useful for routes that can return more than one type.
• AnyResponse
  A type erased response useful for routes that can return more than one type.
• AsyncBasicResponder
  A basic, async closure-based Responder.
• AsyncPasswordHasher
• BaseNEncoding
• BasicAuthorization
  A basic username and password.
• BasicResponder
  A basic, closure-based Responder.
• BearerAuthorization
  A bearer token.
• ByteCount
  let bytes: ByteCount = “2kb” print(bytes.value) // 2048
• ClientRequest
• ClientResponse
• ContentConfiguration
  Configures which Encoders and Decoders to use when interacting with data in HTTP messages.
• DecoderUnwrapper
• DirectoryConfiguration
  DirectoryConfiguration represents a configured working directory. It can also be used to derive a working directory automatically.
• DotEnvFile
  Reads dotenv (.env) files and loads them into the current process.
• Environment
  The environment the application is running in, i.e., production, dev, etc. All Containers will have an Environment that can be used to dynamically register and configure services.
• ErrorSource
  A source-code location.
• Extend
  A wrapper around a simple [String: Any] storage dictionary used to implement Extendable.
• File
  Represents a single file.
• FileIO
  FileIO is a convenience wrapper around SwiftNIO’s NonBlockingFileIO.
• HOTP
  Create a one-time password using hash-based message authentication codes.
• HTTPCookies
  A collection of HTTPCookies.
• HTTPMediaType
  Represents an encoded data-format, used in HTTP, HTML, email, and elsewhere.
• HTTPMediaTypePreference
  Represents a MediaType and its associated preference, q.
• HTTPMediaTypeSet
  A collection for efficiently determining if a set of types contains another type.
• MemorySessions
  Simple in-memory sessions implementation.
• Middlewares
  Configures an application’s active Middleware. Middleware will be used in the order they are added.
• PlaintextDecoder
  Decodes data as plaintext, utf8.
• PlaintextEncoder
  Encodes data as plaintext, utf8.
• PlaintextRenderer
• Redirect
  Specifies the type of redirect that the client should receive.
• ResponseCompressionMiddleware
  Overrides the response compression settings for a route.
• RouteNotFound
• SessionData
  A container for storing data associated with a given SessionID.
• SessionID
• SessionsConfiguration
  Configuration options for sessions.
• StackTrace
• Storage
  A container providing arbitrary storage for extensions of an existing type, designed to obviate the problem of being unable to add stored properties to a type in an extension. Each stored item is keyed by a type conforming to StorageKey protocol.
• TOTP
  Create a one-time password using hash-based message authentication codes and taking uniqueness from the time.
• URI
  A type for constructing and manipulating (most) Uniform Resource Indicators.
• URLEncodedFormDecoder
  Decodes instances of Decodable types from application/x-www-form-urlencoded data.
• URLEncodedFormEncoder
  Encodes Encodable instances to application/x-www-form-urlencoded data.
• Validation
• ValidationResult
• Validations
• ValidationsError
• ValidationsResult
• Validator
• ValidatorResults
• View
• WebSocketMaxFrameSize
• WebSocketUpgrader
  Handles upgrading an HTTP connection to a WebSocket

Variables

• Bcrypt
  Creates and verifies BCrypt hashes.

Operators

• !(_:)
  Inverts a Validationx`.
• &&(_:_:)
  Combines two Validators using AND logic, succeeding if both Validators succeed without error.
• +(_:_:)
  Unions two character sets.
• ??(_:_:)
  Applies nil coalescing to a future’s optional and a concrete type.
• ||(_:_:)
  Combines two Validators, succeeding if either of the Validators does not fail.

Type Aliases

• HTTPStatus
  Less verbose typealias for HTTPResponseStatus.
• ValidationKey
• VaporSendableMetatype

Enumerations

• Base32
• Base64
• BasicCodingKey
  A basic CodingKey implementation.
• BcryptError
• BindAddress
• BodyStreamResult
• CacheExpirationTime
  Defines the lifetime of an entry in a cache.
• EndpointCacheError
• HTTPBodyStreamStrategy
  Determines how an incoming HTTP request’s body is collected.
• HTTPVersionMajor
• HelpFormat
  Available formatting options for generating debug info for Debuggable errors.
• OTPDigest
  Supported OTP digests.
• OTPDigits
  Supported OTP output sizes.
• RangeResult
  Type used by Range and Count validators to indicate where a value fell within a range.
• RedirectType
  Specifies the type of redirect that the client should receive.

Extended Modules

• ConsoleKitCommands
• Foundation
• Logging
• MultipartKit
• NIOCore
• NIOHTTP1
• RoutingKit
• Swift
• WebSocketKit