Vapor

Topics

Classes

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

Protocols

• protocol 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).
• protocol AnyOptionalType
  Type-erased OptionalType
• protocol AsyncAuthenticator
  Helper for creating authentication middleware.
• protocol AsyncBasicAuthenticator
  Helper for creating authentication middleware using the Basic authorization header.
• protocol AsyncBearerAuthenticator
  Helper for creating authentication middleware using the Bearer authorization header.
• protocol AsyncBodyStreamWriter
  A type that represents the writable handle of a streamed Response body
• protocol AsyncCredentialsAuthenticator
  Helper for creating authentication middleware using request body contents.
• protocol 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.
• protocol AsyncRequestAuthenticator
  Help for creating authentication middleware based on Request.
• protocol AsyncRequestDecodable
  Can convert Request to a Self.
• protocol AsyncResponder
• protocol AsyncResponseEncodable
  Can convert self to a Response.
• protocol AsyncSessionAuthenticator
  Helper for creating authentication middleware in conjunction with SessionsMiddleware.
• protocol AsyncSessionDriver
  Capable of managing CRUD operations for Sessions.
• protocol Authenticatable
  Capable of being authenticated.
• protocol Authenticator
  Helper for creating authentication middleware.
• protocol BasicAuthenticator
  Helper for creating authentication middleware using the Basic authorization header.
• protocol BearerAuthenticator
  Helper for creating authentication middleware using the Bearer authorization header.
• protocol BodyStreamWriter
  A type that represents the writable handle of a streamed Response body.
• protocol Cache
  Codable key-value pair cache.
• protocol Client
• protocol Content
  Convertible to / from content in an HTTP message.
• protocol ContentContainer
• protocol ContentDecoder
  Conform a type to this protocol to make it usable for decoding data via Vapor’s ContentConfiguration system.
• protocol ContentEncoder
  Conform a type to this protocol to make it usable for encoding data via Vapor’s ContentConfiguration system.
• protocol CredentialsAuthenticator
  Helper for creating authentication middleware using request body contents.
• protocol DebuggableError
  Debuggable provides an interface that allows a type to be more easily debugged in the case of an error.
• protocol Extendable
  Types conforming to Extendable can have stored properties added in extension by using the Extend struct.
• protocol 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
• protocol LockKey
• protocol 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.
• protocol OptionalType
  Capable of being represented by an optional wrapped type.
• protocol PasswordHasher
• protocol RequestAuthenticator
  Help for creating authentication middleware based on Request.
• protocol RequestDecodable
  Can convert Request to a Self.
• protocol Responder
• protocol ResponseEncodable
  Can convert self to a Response.
• protocol RouteCollection
  Groups collections of routes together for adding to a router.
• protocol RoutesBuilder
• protocol Server
• protocol SessionAuthenticatable
  Models conforming to this protocol can have their authentication status cached using SessionAuthenticator.
• protocol SessionAuthenticator
  Helper for creating authentication middleware in conjunction with SessionsMiddleware.
• protocol SessionDriver
  Capable of managing CRUD operations for Sessions.
• protocol StorageKey
  A key used to store values in a Storage must conform to this protocol.
• protocol URLQueryContainer
  Helper for encoding and decoding data from an HTTP request query string.
• protocol URLQueryDecoder
• protocol URLQueryEncoder
• protocol Upgrader
  Conformance for any struct that performs an HTTP Upgrade
• protocol Validatable
  Capable of being validated. Conformance adds a throwing validate() method.
• protocol ValidatorResult
• protocol ViewRenderer

Structures

• struct 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.
• struct AnyAsyncResponse
  A type erased response useful for routes that can return more than one type.
• struct AnyResponse
  A type erased response useful for routes that can return more than one type.
• struct AsyncBasicResponder
  A basic, async closure-based Responder.
• struct AsyncPasswordHasher
• struct BaseNEncoding
• struct BasicAuthorization
  A basic username and password.
• struct BasicResponder
  A basic, closure-based Responder.
• struct BearerAuthorization
  A bearer token.
• struct ByteCount
  let bytes: ByteCount = “2kb” print(bytes.value) // 2048
• struct ClientRequest
• struct ClientResponse
• struct ContentConfiguration
  Configures which Encoders and Decoders to use when interacting with data in HTTP messages.
• struct DecoderUnwrapper
• struct DirectoryConfiguration
  DirectoryConfiguration represents a configured working directory. It can also be used to derive a working directory automatically.
• struct DotEnvFile
  Reads dotenv (.env) files and loads them into the current process.
• struct 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.
• struct ErrorSource
  A source-code location.
• struct Extend
  A wrapper around a simple [String: Any] storage dictionary used to implement Extendable.
• struct File
  Represents a single file.
• struct FileIO
  FileIO is a convenience wrapper around SwiftNIO’s NonBlockingFileIO.
• struct HOTP
  Create a one-time password using hash-based message authentication codes.
• struct HTTPCookies
  A collection of HTTPCookies.
• struct HTTPMediaType
  Represents an encoded data-format, used in HTTP, HTML, email, and elsewhere.
• struct HTTPMediaTypePreference
  Represents a MediaType and its associated preference, q.
• struct HTTPMediaTypeSet
  A collection for efficiently determining if a set of types contains another type.
• struct MemorySessions
  Simple in-memory sessions implementation.
• struct Middlewares
  Configures an application’s active Middleware. Middleware will be used in the order they are added.
• struct PlaintextDecoder
  Decodes data as plaintext, utf8.
• struct PlaintextEncoder
  Encodes data as plaintext, utf8.
• struct PlaintextRenderer
• struct Redirect
  Specifies the type of redirect that the client should receive.
• struct ResponseCompressionMiddleware
  Overrides the response compression settings for a route.
• struct RouteNotFound
• struct SessionData
  A container for storing data associated with a given SessionID.
• struct SessionID
• struct SessionsConfiguration
  Configuration options for sessions.
• struct StackTrace
• struct 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.
• struct TOTP
  Create a one-time password using hash-based message authentication codes and taking uniqueness from the time.
• struct URI
  A type for constructing and manipulating (most) Uniform Resource Indicators.
• struct URLEncodedFormDecoder
  Decodes instances of Decodable types from application/x-www-form-urlencoded data.
• struct URLEncodedFormEncoder
  Encodes Encodable instances to application/x-www-form-urlencoded data.
• struct Validation
• struct ValidationResult
• struct Validations
• struct ValidationsError
• struct ValidationsResult
• struct Validator
• struct ValidatorResults
• struct View
• struct WebSocketMaxFrameSize
• struct WebSocketUpgrader
  Handles upgrading an HTTP connection to a WebSocket

Variables

• var Bcrypt: BCryptDigest
  Creates and verifies BCrypt hashes.

Operators

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

Type Aliases

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

Enumerations

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

Extended Modules

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