Skip to content

Vapor API Docs

AsyncKit

Core

Vapor AsyncKit RoutingKit ConsoleKit ConsoleLogger beta WebSocketKit MultipartKit

Authentication

JWT JWTKit Authentication

Templating

Leaf LeafKit

Database

Fluent FluentKit FluentSQL FluentPostgresDriver FluentMongoDriver FluentMySQLDriver FluentSQLiteDriver SQLKit PostgresKit MySQLKit SQLiteKit PostgresNIO MySQLNIO SQLiteNIO Redis

Queues

Queues QueuesRedisDriver

Push Notifications

APNS

Testing

XCTVapor VaporTesting XCTFluent XCTQueues

Legacy connection pools
EventLoopConnectionPool
EventLoopGroupConnectionPool
ConnectionPoolSource
- Associated Types
- Connection
- Instance Methods
- func makeConnection(logger: Logger, on: any EventLoop) -> EventLoopFuture<Self.Connection>
ConnectionPoolItem
- Instance Properties
- var eventLoop: any EventLoop
- var isClosed: Bool
- Instance Methods
- func close() -> EventLoopFuture<Void>
ConnectionPoolError
- Enumeration Cases
- case shutdown
ConnectionPoolTimeoutError
- Enumeration Cases
- case connectionRequestTimeout
Optionals
func strictMap<A, Res>(A?, (A) throws -> Res) rethrows -> Res?
func strictMap<A, B, Res>(A?, B?, (A, B) throws -> Res) rethrows -> Res?
func strictMap<A, B, C, Res>(A?, B?, C?, (A, B, C) throws -> Res) rethrows -> Res?
func strictMap<A, B, C, D, Res>(A?, B?, C?, D?, (A, B, C, D) throws -> Res) rethrows -> Res?
func strictMap<A, B, C, D, E, Res>(A?, B?, C?, D?, E?, (A, B, C, D, E) throws -> Res) rethrows -> Res?
func strictMap<A, B, C, D, E, F, Res>(A?, B?, C?, D?, E?, F?, (A, B, C, D, E, F) throws -> Res) rethrows -> Res?
func strictMap<A, B, C, D, E, F, G, Res>(A?, B?, C?, D?, E?, F?, G?, (A, B, C, D, E, F, G) throws -> Res) rethrows -> Res?
func strictMap<A, B, C, D, E, F, G, H, Res>(A?, B?, C?, D?, E?, F?, G?, H?, (A, B, C, D, E, F, G, H) throws -> Res) rethrows -> Res?
func strictMap<A, B, C, D, E, F, G, H, I, Res>(A?, B?, C?, D?, E?, F?, G?, H?, I?, (A, B, C, D, E, F, G, H, I) throws -> Res) rethrows -> Res?
func strictMap<A, B, C, D, E, F, G, H, I, J, Res>(A?, B?, C?, D?, E?, F?, G?, H?, I?, J?, (A, B, C, D, E, F, G, H, I, J) throws -> Res) rethrows -> Res?
func strictMap<A, B, C, D, E, F, G, H, I, J, K, Res>(A?, B?, C?, D?, E?, F?, G?, H?, I?, J?, K?, (A, B, C, D, E, F, G, H, I, J, K) throws -> Res) rethrows -> Res?
func strictMap<A, B, C, D, E, F, G, H, I, J, K, L, Res>(A?, B?, C?, D?, E?, F?, G?, H?, I?, J?, K?, L?, (A, B, C, D, E, F, G, H, I, J, K, L) throws -> Res) rethrows -> Res?
func strictMap<A, B, C, D, E, F, G, H, I, J, K, L, M, Res>(A?, B?, C?, D?, E?, F?, G?, H?, I?, J?, K?, L?, M?, (A, B, C, D, E, F, G, H, I, J, K, L, M) throws -> Res) rethrows -> Res?
func strictMap<A, B, C, D, E, F, G, H, I, J, K, L, M, N, Res>(A?, B?, C?, D?, E?, F?, G?, H?, I?, J?, K?, L?, M?, N?, (A, B, C, D, E, F, G, H, I, J, K, L, M, N) throws -> Res) rethrows -> Res?
func strictMap<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, Res>(A?, B?, C?, D?, E?, F?, G?, H?, I?, J?, K?, L?, M?, N?, O?, (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O) throws -> Res) rethrows -> Res?
func strictMap<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Res>(A?, B?, C?, D?, E?, F?, G?, H?, I?, J?, K?, L?, M?, N?, O?, P?, (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P) throws -> Res) rethrows -> Res?
func strictMap<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, Res>(A?, B?, C?, D?, E?, F?, G?, H?, I?, J?, K?, L?, M?, N?, O?, P?, Q?, (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q) throws -> Res) rethrows -> Res?
func strictMap<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, Res>(A?, B?, C?, D?, E?, F?, G?, H?, I?, J?, K?, L?, M?, N?, O?, P?, Q?, R?, (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R) throws -> Res) rethrows -> Res?
func strictMap<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, Res>(A?, B?, C?, D?, E?, F?, G?, H?, I?, J?, K?, L?, M?, N?, O?, P?, Q?, R?, S?, (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S) throws -> Res) rethrows -> Res?
func strictMap<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, Res>(A?, B?, C?, D?, E?, F?, G?, H?, I?, J?, K?, L?, M?, N?, O?, P?, Q?, R?, S?, T?, (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T) throws -> Res) rethrows -> Res?
EventLoop and EventLoopGroup
func flatten<T>([EventLoopFuture<T>]) -> EventLoopFuture<[T]>
func flatten([EventLoopFuture<Void>]) -> EventLoopFuture<Void>
func future() -> EventLoopFuture<Void>
func future<T>(error: any Error) -> EventLoopFuture<T>
func future<T>(T) -> EventLoopFuture<T>
func future<T>(result: Result<T, any Error>) -> EventLoopFuture<T>
func tryFuture<T>(() throws -> T) -> EventLoopFuture<T>
EventLoopFuture
EventLoopFutureQueue
func mapEach<Result>(KeyPath<Value.Element, Result>) -> EventLoopFuture<[Result]>
func mapEach<Result>((Value.Element) -> Result) -> EventLoopFuture<[Result]>
func mapEachCompact<Result>(KeyPath<Value.Element, Result?>) -> EventLoopFuture<[Result]>
func mapEachCompact<Result>((Value.Element) -> Result?) -> EventLoopFuture<[Result]>
func mapEachFlat<ResultSegment>(KeyPath<Value.Element, ResultSegment>) -> EventLoopFuture<[ResultSegment.Element]>
func mapEachFlat<ResultSegment>((Value.Element) -> ResultSegment) -> EventLoopFuture<[ResultSegment.Element]>
func flatMapEach(on: any EventLoop, (Value.Element) -> EventLoopFuture<Void>) -> EventLoopFuture<Void>
func flatMapEach<Result>(on: any EventLoop, (Value.Element) -> EventLoopFuture<Result>) -> EventLoopFuture<[Result]>
func flatMapEachCompact<Result>(on: any EventLoop, (Value.Element) -> EventLoopFuture<Result?>) -> EventLoopFuture<[Result]>
func flatMapEachThrowing<Result>((Value.Element) throws -> Result) -> EventLoopFuture<[Result]>
func flatMapEachCompactThrowing<Result>((Value.Element) throws -> Result?) -> EventLoopFuture<[Result]>
func sequencedFlatMapEach((Value.Element) -> EventLoopFuture<Void>) -> EventLoopFuture<Void>
func sequencedFlatMapEach<Result>((Value.Element) -> EventLoopFuture<Result>) -> EventLoopFuture<[Result]>
func sequencedFlatMapEachCompact<Result>((Value.Element) -> EventLoopFuture<Result?>) -> EventLoopFuture<[Result]>
static func whenTheySucceed<A, B>(EventLoopFuture<A>, EventLoopFuture, file: StaticString, line: UInt) -> EventLoopFuture<(A, B)>
static func whenTheySucceed<A, B, C>(EventLoopFuture<A>, EventLoopFuture, EventLoopFuture<C>, file: StaticString, line: UInt) -> EventLoopFuture<(A, B, C)>
static func whenTheySucceed<A, B, C, D>(EventLoopFuture<A>, EventLoopFuture, EventLoopFuture<C>, EventLoopFuture<D>, file: StaticString, line: UInt) -> EventLoopFuture<(A, B, C, D)>
static func whenTheySucceed<A, B, C, D, E>(EventLoopFuture<A>, EventLoopFuture, EventLoopFuture<C>, EventLoopFuture<D>, EventLoopFuture<E>, file: StaticString, line: UInt) -> EventLoopFuture<(A, B, C, D, E)>
static func whenTheySucceed<A, B, C, D, E, F>(EventLoopFuture<A>, EventLoopFuture, EventLoopFuture<C>, EventLoopFuture<D>, EventLoopFuture<E>, EventLoopFuture<F>, file: StaticString, line: UInt) -> EventLoopFuture<(A, B, C, D, E, F)>
static func whenTheySucceed<A, B, C, D, E, F, G>(EventLoopFuture<A>, EventLoopFuture, EventLoopFuture<C>, EventLoopFuture<D>, EventLoopFuture<E>, EventLoopFuture<F>, EventLoopFuture<G>, file: StaticString, line: UInt) -> EventLoopFuture<(A, B, C, D, E, F, G)>
static func whenTheySucceed<A, B, C, D, E, F, G, H>(EventLoopFuture<A>, EventLoopFuture, EventLoopFuture<C>, EventLoopFuture<D>, EventLoopFuture<E>, EventLoopFuture<F>, EventLoopFuture<G>, EventLoopFuture<H>, file: StaticString, line: UInt) -> EventLoopFuture<(A, B, C, D, E, F, G, H)>
static func whenTheySucceed<A, B, C, D, E, F, G, H, I>(EventLoopFuture<A>, EventLoopFuture, EventLoopFuture<C>, EventLoopFuture<D>, EventLoopFuture<E>, EventLoopFuture<F>, EventLoopFuture<G>, EventLoopFuture<H>, EventLoopFuture, file: StaticString, line: UInt) -> EventLoopFuture<(A, B, C, D, E, F, G, H, I)>
static func whenTheySucceed<A, B, C, D, E, F, G, H, I, J>(EventLoopFuture<A>, EventLoopFuture, EventLoopFuture<C>, EventLoopFuture<D>, EventLoopFuture<E>, EventLoopFuture<F>, EventLoopFuture<G>, EventLoopFuture<H>, EventLoopFuture, EventLoopFuture<J>, file: StaticString, line: UInt) -> EventLoopFuture<(A, B, C, D, E, F, G, H, I, J)>
static func whenTheySucceed<A, B, C, D, E, F, G, H, I, J, K>(EventLoopFuture<A>, EventLoopFuture, EventLoopFuture<C>, EventLoopFuture<D>, EventLoopFuture<E>, EventLoopFuture<F>, EventLoopFuture<G>, EventLoopFuture<H>, EventLoopFuture, EventLoopFuture<J>, EventLoopFuture<K>, file: StaticString, line: UInt) -> EventLoopFuture<(A, B, C, D, E, F, G, H, I, J, K)>
static func whenTheySucceed<A, B, C, D, E, F, G, H, I, J, K, L>(EventLoopFuture<A>, EventLoopFuture, EventLoopFuture<C>, EventLoopFuture<D>, EventLoopFuture<E>, EventLoopFuture<F>, EventLoopFuture<G>, EventLoopFuture<H>, EventLoopFuture, EventLoopFuture<J>, EventLoopFuture<K>, EventLoopFuture<L>, file: StaticString, line: UInt) -> EventLoopFuture<(A, B, C, D, E, F, G, H, I, J, K, L)>
static func whenTheySucceed<A, B, C, D, E, F, G, H, I, J, K, L, M>(EventLoopFuture<A>, EventLoopFuture, EventLoopFuture<C>, EventLoopFuture<D>, EventLoopFuture<E>, EventLoopFuture<F>, EventLoopFuture<G>, EventLoopFuture<H>, EventLoopFuture, EventLoopFuture<J>, EventLoopFuture<K>, EventLoopFuture<L>, EventLoopFuture<M>, file: StaticString, line: UInt) -> EventLoopFuture<(A, B, C, D, E, F, G, H, I, J, K, L, M)>
static func whenTheySucceed<A, B, C, D, E, F, G, H, I, J, K, L, M, N>(EventLoopFuture<A>, EventLoopFuture, EventLoopFuture<C>, EventLoopFuture<D>, EventLoopFuture<E>, EventLoopFuture<F>, EventLoopFuture<G>, EventLoopFuture<H>, EventLoopFuture, EventLoopFuture<J>, EventLoopFuture<K>, EventLoopFuture<L>, EventLoopFuture<M>, EventLoopFuture<N>, file: StaticString, line: UInt) -> EventLoopFuture<(A, B, C, D, E, F, G, H, I, J, K, L, M, N)>
static func whenTheySucceed<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O>(EventLoopFuture<A>, EventLoopFuture, EventLoopFuture<C>, EventLoopFuture<D>, EventLoopFuture<E>, EventLoopFuture<F>, EventLoopFuture<G>, EventLoopFuture<H>, EventLoopFuture, EventLoopFuture<J>, EventLoopFuture<K>, EventLoopFuture<L>, EventLoopFuture<M>, EventLoopFuture<N>, EventLoopFuture<O>, file: StaticString, line: UInt) -> EventLoopFuture<(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O)>
static func whenTheySucceed<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P>(EventLoopFuture<A>, EventLoopFuture, EventLoopFuture<C>, EventLoopFuture<D>, EventLoopFuture<E>, EventLoopFuture<F>, EventLoopFuture<G>, EventLoopFuture<H>, EventLoopFuture, EventLoopFuture<J>, EventLoopFuture<K>, EventLoopFuture<L>, EventLoopFuture<M>, EventLoopFuture<N>, EventLoopFuture<O>, EventLoopFuture, file: StaticString, line: UInt) -> EventLoopFuture<(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P)>
static func whenTheySucceed<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q>(EventLoopFuture<A>, EventLoopFuture, EventLoopFuture<C>, EventLoopFuture<D>, EventLoopFuture<E>, EventLoopFuture<F>, EventLoopFuture<G>, EventLoopFuture<H>, EventLoopFuture, EventLoopFuture<J>, EventLoopFuture<K>, EventLoopFuture<L>, EventLoopFuture<M>, EventLoopFuture<N>, EventLoopFuture<O>, EventLoopFuture, EventLoopFuture<Q>, file: StaticString, line: UInt) -> EventLoopFuture<(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q)>
static func whenTheySucceed<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R>(EventLoopFuture<A>, EventLoopFuture, EventLoopFuture<C>, EventLoopFuture<D>, EventLoopFuture<E>, EventLoopFuture<F>, EventLoopFuture<G>, EventLoopFuture<H>, EventLoopFuture, EventLoopFuture<J>, EventLoopFuture<K>, EventLoopFuture<L>, EventLoopFuture<M>, EventLoopFuture<N>, EventLoopFuture<O>, EventLoopFuture, EventLoopFuture<Q>, EventLoopFuture<R>, file: StaticString, line: UInt) -> EventLoopFuture<(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R)>
static func whenTheySucceed<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S>(EventLoopFuture<A>, EventLoopFuture, EventLoopFuture<C>, EventLoopFuture<D>, EventLoopFuture<E>, EventLoopFuture<F>, EventLoopFuture<G>, EventLoopFuture<H>, EventLoopFuture, EventLoopFuture<J>, EventLoopFuture<K>, EventLoopFuture<L>, EventLoopFuture<M>, EventLoopFuture<N>, EventLoopFuture<O>, EventLoopFuture, EventLoopFuture<Q>, EventLoopFuture<R>, EventLoopFuture<S>, file: StaticString, line: UInt) -> EventLoopFuture<(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S)>
static func whenTheySucceed<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T>(EventLoopFuture<A>, EventLoopFuture, EventLoopFuture<C>, EventLoopFuture<D>, EventLoopFuture<E>, EventLoopFuture<F>, EventLoopFuture<G>, EventLoopFuture<H>, EventLoopFuture, EventLoopFuture<J>, EventLoopFuture<K>, EventLoopFuture<L>, EventLoopFuture<M>, EventLoopFuture<N>, EventLoopFuture<O>, EventLoopFuture, EventLoopFuture<Q>, EventLoopFuture<R>, EventLoopFuture<S>, EventLoopFuture<T>, file: StaticString, line: UInt) -> EventLoopFuture<(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T)>
func `guard`((Value) -> Bool, else: @autoclosure () -> any Error) -> EventLoopFuture<Value>
func flatMapAlways<NewValue>(file: StaticString, line: UInt, (Result<Value, any Error>) -> EventLoopFuture<NewValue>) -> EventLoopFuture<NewValue>
func nonempty<E>(orError: @autoclosure () -> E) -> EventLoopFuture<Value>
func nonemptyMap<NewValue>((Value) -> NewValue) -> EventLoopFuture<NewValue>
func nonemptyMap<NewValue>(or: @autoclosure () -> NewValue, (Value) -> NewValue) -> EventLoopFuture<NewValue>
func nonemptyFlatMapThrowing<NewValue>((Value) throws -> NewValue) -> EventLoopFuture<NewValue>
func nonemptyFlatMapThrowing<NewValue>(or: @autoclosure () -> NewValue, (Value) throws -> NewValue) -> EventLoopFuture<NewValue>
func nonemptyFlatMap<NewValue>((Value) -> EventLoopFuture<NewValue>) -> EventLoopFuture<NewValue>
func nonemptyFlatMap<NewValue>(or: @autoclosure () -> NewValue, (Value) -> EventLoopFuture<NewValue>) -> EventLoopFuture<NewValue>
func nonemptyFlatMap<NewValue>(orFlat: @autoclosure () -> EventLoopFuture<NewValue>, (Value) -> EventLoopFuture<NewValue>) -> EventLoopFuture<NewValue>
func optionalMap<Wrapped, Result>((Wrapped) -> Result?) -> EventLoopFuture<Result?>
func optionalFlatMap<Wrapped, Result>((Wrapped) -> EventLoopFuture<Result>) -> EventLoopFuture<Result?>
func optionalFlatMap<Wrapped, Result>((Wrapped) -> EventLoopFuture<Result?>) -> EventLoopFuture<Result?>
func optionalFlatMapThrowing<Wrapped, Result>((Wrapped) throws -> Result?) -> EventLoopFuture<Result?>
func transform<T>(to: EventLoopFuture<T>) -> EventLoopFuture<T>
func transform<T>(to: @autoclosure () -> T) -> EventLoopFuture<T>
func tryFlatMap<NewValue>(file: StaticString, line: UInt, (Value) throws -> EventLoopFuture<NewValue>) -> EventLoopFuture<NewValue>
EventLoopFuture operators
static func + (EventLoopFuture<Value>, EventLoopFuture<Value>) -> EventLoopFuture<Value>
static func + <T>(EventLoopFuture<Value>, EventLoopFuture<Value>) -> EventLoopFuture<Value>
static func += (inout EventLoopFuture<Value>, EventLoopFuture<Value>)
static func += <T>(inout EventLoopFuture<Value>, EventLoopFuture<Value>)
static func * (EventLoopFuture<Value>, EventLoopFuture<Value>) -> EventLoopFuture<Value>
static func *= (inout EventLoopFuture<Value>, EventLoopFuture<Value>)
static func % (EventLoopFuture<Value>, EventLoopFuture<Value>) -> EventLoopFuture<Value>
static func %= (inout EventLoopFuture<Value>, EventLoopFuture<Value>)
static func < (EventLoopFuture<Value>, EventLoopFuture<some BinaryInteger>) -> EventLoopFuture<Bool>
static func <= (EventLoopFuture<Value>, EventLoopFuture<some BinaryInteger>) -> EventLoopFuture<Bool>
static func > (EventLoopFuture<Value>, EventLoopFuture<some BinaryInteger>) -> EventLoopFuture<Bool>
static func >= (EventLoopFuture<Value>, EventLoopFuture<some BinaryInteger>) -> EventLoopFuture<Bool>
static func << (EventLoopFuture<Value>, EventLoopFuture<some BinaryInteger>) -> EventLoopFuture<Value>
static func <<= (inout EventLoopFuture<Value>, EventLoopFuture<some BinaryInteger>)
static func >> (EventLoopFuture<Value>, EventLoopFuture<some BinaryInteger>) -> EventLoopFuture<Value>
static func >>= (inout EventLoopFuture<Value>, EventLoopFuture<some BinaryInteger>)
static func & (EventLoopFuture<Value>, EventLoopFuture<Value>) -> EventLoopFuture<Value>
static func &= (inout EventLoopFuture<Value>, EventLoopFuture<Value>)
static func | (EventLoopFuture<Value>, EventLoopFuture<Value>) -> EventLoopFuture<Value>
static func |= (inout EventLoopFuture<Value>, EventLoopFuture<Value>)
static func ^ (EventLoopFuture<Value>, EventLoopFuture<Value>) -> EventLoopFuture<Value>
static func ^= (inout EventLoopFuture<Value>, EventLoopFuture<Value>)
static func ~ (EventLoopFuture<Value>) -> EventLoopFuture<Value>
Extended Modules
NIOCore
Swift

API Docs
Framework Docs

- API Docs
  
  Reference documentation for Vapor
- Framework Docs
  
  Learn how to use Vapor
Home
Store
Showcase
Team
Blog
GitHub
Theme
- Light
- Dark
- System

Instance Property

logger

For lifecycle logs.

let logger: Logger

Vapor

Reference documentation for Vapor and its ecosystem.

Community

Team
Join our Discord
Store
Showcase
Supporters

Resources

Blog
Framework Docs
API Docs
Press Kit
Help

Twitter
Mastodon
Bsky
GitHub