Vapor

Topics

Classes

• class Application
  Core type representing a Vapor application.
• class CORSMiddleware
  Middleware that adds support for CORS settings in request responses. For configuration of this middleware please use the CORSMiddleware.Configuration object.
• actor EndpointCache
  Handles the complexities of HTTP caching.
• class ErrorMiddleware
  Captures all errors and transforms them into an internal server error HTTP response.
• actor FileETagHashCache
  Caches the content hashes used for advanced ETag comparison.
• class FileMiddleware
  Serves static files from a public directory.
• class MetricsMiddleware
  Creates metrics for every request
• 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 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 Authenticatable
  A protocol to which a type may conform to enable use of that type for authentication.
• protocol BasicAuthenticator
  HTTP Basic Auth implementation of RequestAuthenticator. Makes it easy to implement basic auth for your own Authenticatable types.
• protocol BearerAuthenticator
• 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
  Protocol for authenticators that use a credentials type to authenticate. See CredentialsAuthenticator for more information. Designed for use with HTML forms, works with JSON as well
• 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 HTTPBodyWriter
  Protocol for writing HTTP response bodies.
• 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 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 RequestAuthenticator
  Helper for creating authentication middleware.
• protocol RequestBodyReader
  Reads an HTTP request body, pulled straight off the connection with backpressure (the server stops reading until the handler asks for more). Implementations come from the HTTP server layer.
• 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
  A server that can handle HTTP requests.
• 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 URLQueryContainer
  Helper for encoding and decoding data from an HTTP request query string.
• protocol URLQueryDecoder
• protocol URLQueryEncoder
• 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 AnyResponse
  A type erased response useful for routes that can return more than one type.
• struct BaseNEncoding
• struct BasicAuthorization
  A basic username and password.
• struct BasicResponder
  A basic, async closure-based Responder.
• struct BearerAuthorization
  A bearer token.
• struct BlackholeClient
  Type that conforms to Client but does nothing and throws an error when used. Can be useful for testing Used when the HTTPClient package trait is disabled
• 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 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 FileSystem for streaming files with a Request to a Response. It handles streaming file chunks to the response body, ETag support and caching and request ranges.
• 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 HTTPVersion
  A structure representing a HTTP version.
• 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
  A ViewRenderer that serves views from files on disk, without any templating.
• struct Redirect
  Specifies the type of redirect that the client should receive.
• struct Request
  Represents an HTTP request in an application.
• struct RequestBodyAlreadyBeingRead
  Thrown when the request body is read from two tasks at once. It is a single-consumer stream, so this is a programmer error, surfaced as a 500 rather than silently reporting an empty end-of-body.
• struct RequestBodyPartiallyConsumed
  Thrown by collect(max:) when something already took bytes off the stream.
• struct RequestBodyReadFailed
  Thrown by a read on a stream whose earlier read failed at the transport.
• struct RequestBodyTransportFailed
  Thrown by the read that finds the request body’s transport has failed: the client hung up part-way through the body, sent fewer bytes than it declared, or sent something the HTTP parser rejected.
• struct Response
  An HTTP response from a server back to the client.
• struct ResponseCompressionMiddleware
  Overrides the response compression settings for a route.
• struct Route
• struct RouteNotFound
• struct Routes
  The routes registered on an Application.
• struct ServerConfiguration
• struct SessionData
  A container for storing data associated with a given SessionID.
• struct SessionID
• struct SessionsConfiguration
  Configuration options for sessions.
• struct SocketAddress
  An address a socket is bound to, or that a peer connected from.
• 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 ValidationCharacterSet
• struct ValidationResult
• struct Validations
• struct ValidationsError
• struct ValidationsResult
• struct Validator
• struct ValidatorResults
• struct View

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 + (ValidationCharacterSet, ValidationCharacterSet) -> ValidationCharacterSet
  Unions two character sets.
• func ||(_:_:)
  Combines two Validators, succeeding if either of the Validators does not fail.

Type Aliases

• typealias VaporSendableMetatype

Enumerations

• enum Base32
• enum Base64
• enum BasicCodingKey
  A basic CodingKey implementation.
• enum BindAddress
• enum BodySizeLimit
  How much of a request body collect(max:) and its relatives will buffer.
• enum CacheExpirationTime
  Defines the lifetime of an entry in a cache.
• enum EndpointCacheError
• enum HelpFormat
  Available formatting options for generating debug info for Debuggable errors.
• enum RangeResult
  Type used by Range and Count validators to indicate where a value fell within a range.
• enum ServerError
  Errors thrown when a Server fails to start.

Extended Modules

• FoundationEssentials
• HTTPTypes
• Logging
• MultipartKit
• RoutingKit
• Swift