Extended Class

EventLoopFuture

extension EventLoopFuture

Topics

Operators

static func & (EventLoopFuture<Value>, EventLoopFuture<Value>) -> EventLoopFuture<Value>
Returns the result of performing a bitwise AND operation on the two given futures
static func &= (inout EventLoopFuture<Value>, EventLoopFuture<Value>)
Stores the result of performing a bitwise AND operation on the two given futures in the left-hand-side variable
static func * (EventLoopFuture<Value>, EventLoopFuture<Value>) -> EventLoopFuture<Value>
Multiplies two futures and produces their product
static func *= (inout EventLoopFuture<Value>, EventLoopFuture<Value>)
Multiplies two futures and stores the result in the left-hand-side variable
static +(_:_:)
Adds two futures and produces their sum
static +=(_:_:)
Adds two futures and stores the result in the left-hand-side variable
static -(_:_:)
Subtracts one future from another and produces their difference
static -=(_:_:)
Subtracts the second future from the first and stores the difference in the left-hand-side variable
static func / (EventLoopFuture<Value>, EventLoopFuture<Value>) -> EventLoopFuture<Value>
Returns the quotient of dividing the first future by the second
static func < (EventLoopFuture<Value>, EventLoopFuture<some BinaryInteger>) -> EventLoopFuture<Bool>
Returns a Boolean value indicating whether the value of the first argument is less than that of the second argument
static func ^ (EventLoopFuture<Value>, EventLoopFuture<Value>) -> EventLoopFuture<Value>
Returns the result of performing a bitwise XOR operation on the two given futures
static func > (EventLoopFuture<Value>, EventLoopFuture<some BinaryInteger>) -> EventLoopFuture<Bool>
Returns a Boolean value indicating whether the value of the first argument is greater than that of the second argument
static func | (EventLoopFuture<Value>, EventLoopFuture<Value>) -> EventLoopFuture<Value>
Returns the result of performing a bitwise OR operation on the two given futures
static func % (EventLoopFuture<Value>, EventLoopFuture<Value>) -> EventLoopFuture<Value>
Returns the remainder of dividing the first future by the second
static func >= (EventLoopFuture<Value>, EventLoopFuture<some BinaryInteger>) -> EventLoopFuture<Bool>
Returns a Boolean value indicating whether the value of the first argument is greater than or equal to that of the second argument
static func <= (EventLoopFuture<Value>, EventLoopFuture<some BinaryInteger>) -> EventLoopFuture<Bool>
Returns a Boolean value indicating whether the value of the first argument is less than or equal to that of the second argument
static func %= (inout EventLoopFuture<Value>, EventLoopFuture<Value>)
Divides the first future by the second and stores the remainder in the left-hand-side variable
static func /= (inout EventLoopFuture<Value>, EventLoopFuture<Value>)
Divides the first future by the second and stores the quotient in the left-hand-side variable
static func |= (inout EventLoopFuture<Value>, EventLoopFuture<Value>)
Stores the result of performing a bitwise OR operation on the two given futures in the left-hand-side variable
static func ^= (inout EventLoopFuture<Value>, EventLoopFuture<Value>)
Stores the result of performing a bitwise XOR operation on the two given futures in the left-hand-side variable
static func << (EventLoopFuture<Value>, EventLoopFuture<some BinaryInteger>) -> EventLoopFuture<Value>
Returns the result of shifting a future’s binary representation the specified number of digits to the left
static func >> (EventLoopFuture<Value>, EventLoopFuture<some BinaryInteger>) -> EventLoopFuture<Value>
Returns the result of shifting a future’s binary representation the specified number of digits to the right
static func >>= (inout EventLoopFuture<Value>, EventLoopFuture<some BinaryInteger>)
Stores the result of shifting a future’s binary representation the specified number of digits to the right in the left-hand-side variable
static func <<= (inout EventLoopFuture<Value>, EventLoopFuture<some BinaryInteger>)
Stores the result of shifting a future’s binary representation the specified number of digits to the left in the left-hand-side variable
static func ~ (EventLoopFuture<Value>) -> EventLoopFuture<Value>
Returns the result of performing a bitwise NOT operation on the given future

Instance Methods

func flatMapAlways<NewValue>(file: StaticString, line: UInt, (Result<Value, any Error>) -> EventLoopFuture<NewValue>) -> EventLoopFuture<NewValue>
When the current EventLoopFuture receives any result, run the provided callback, which will provide a new EventLoopFuture. Essentially combines the behaviors of .always(_:) and .flatMap(file:line:_:).
func flatMapEach(on:_:)
Calls a closure, which returns an EventLoopFuture, on each element in a sequence that is wrapped by an EventLoopFuture. No results from each future are expected.
func flatMapEachCompact<Result>(on: any EventLoop, (Value.Element) -> EventLoopFuture<Result?>) -> EventLoopFuture<[Result]>
Calls a closure, which returns an EventLoopFuture<Optional>, on each element in a sequence that is wrapped by an EventLoopFuture.
func flatMapEachCompactThrowing<Result>((Value.Element) throws -> Result?) -> EventLoopFuture<[Result]>
Calls a closure, which returns an Optional, on each element in the sequence that is wrapped by an EventLoopFuture.
func flatMapEachThrowing<Result>((Value.Element) throws -> Result) -> EventLoopFuture<[Result]>
Calls a closure on each element in the sequence that is wrapped by an EventLoopFuture.
func `guard`((Value) -> Bool, else: @autoclosure () -> any Error) -> EventLoopFuture<Value>
Guards that the future’s value satisfies the callback’s condition or fails with the given error.
func mapEach(_:)
Gets the value of a key path for each element in the sequence that is wrapped by an EventLoopFuture.
func mapEachCompact(_:)
Gets the optional value of a key path for each element in the sequence that is wrapped by an EventLoopFuture.
func mapEachFlat(_:)
Gets the collection value of a key path for each element in the sequence that is wrapped by an EventLoopFuture, combining the results into a single result collection.
func nonempty<E>(orError: @autoclosure () -> E) -> EventLoopFuture<Value>
Checks that the future’s value (if any) returns false for .isEmpty. If the check fails, the provided error is thrown.
func nonemptyFlatMap<NewValue>((Value) -> EventLoopFuture<NewValue>) -> EventLoopFuture<NewValue>
Checks that the future’s value (if any) returns false for .isEmpty. If the check fails, a new future with an empty array as its value is returned. Otherwise, the provided normal flatMap() callback is invoked. The callback’s returned future must have a value type that is an Array or a RangeReplaceableCollection.
func nonemptyFlatMap<NewValue>(or: @autoclosure () -> NewValue, (Value) -> EventLoopFuture<NewValue>) -> EventLoopFuture<NewValue>
Checks that the future’s value (if any) returns false for .isEmpty. If the check fails, a new future with the provided alternate value is returned. Otherwise, the provided normal flatMap() callback is invoked.
func nonemptyFlatMap<NewValue>(orFlat: @autoclosure () -> EventLoopFuture<NewValue>, (Value) -> EventLoopFuture<NewValue>) -> EventLoopFuture<NewValue>
Checks that the future’s value (if any) returns false for .isEmpty. If the check fails, the provided alternate future is returned. Otherwise, the provided normal flatMap() callback is invoked.
func nonemptyFlatMapThrowing<NewValue>((Value) throws -> NewValue) -> EventLoopFuture<NewValue>
Checks that the future’s value (if any) returns false for .isEmpty. If the check fails, a new future with an empty array as its value is returned. Otherwise, the provided normal flatMapThrowing() callback is invoked. The callback’s return type must be an Array or a RangeReplaceableCollection.
func nonemptyFlatMapThrowing<NewValue>(or: @autoclosure () -> NewValue, (Value) throws -> NewValue) -> EventLoopFuture<NewValue>
Checks that the future’s value (if any) returns false for .isEmpty. If the check fails, a new future with the provided alternate value is returned. Otherwise, the provided normal flatMapThrowing() callback is invoked.
func nonemptyMap<NewValue>((Value) -> NewValue) -> EventLoopFuture<NewValue>
Checks that the future’s value (if any) returns false for .isEmpty. If the check fails, a new future with an empty array as its value is returned. Otherwise, the provided normal map() callback is invoked. The callback’s return type must be an Array or a RangeReplaceableCollection.
func nonemptyMap<NewValue>(or: @autoclosure () -> NewValue, (Value) -> NewValue) -> EventLoopFuture<NewValue>
Checks that the future’s value (if any) returns false for .isEmpty. If the check fails, a new future with the provided alternate value is returned. Otherwise, the provided normal map() callback is invoked.
func optionalFlatMap(_:)
Calls a closure on an optional value in an EventLoopFuture if it exists.
func optionalFlatMapThrowing<Wrapped, Result>((Wrapped) throws -> Result?) -> EventLoopFuture<Result?>
Calls a throwing closure on an optional value in an EventLoopFuture if it exists.
func optionalMap<Wrapped, Result>((Wrapped) -> Result?) -> EventLoopFuture<Result?>
Calls a closure on an optional value that is wrapped in an EventLoopFuture if it exists.
func sequencedFlatMapEach(_:)
An overload of sequencedFlatMapEach(_:) which returns a Void future instead of [Void] when the result type of the transform closure is Void.
func sequencedFlatMapEachCompact<Result>((Value.Element) -> EventLoopFuture<Result?>) -> EventLoopFuture<[Result]>
Variant of sequencedFlatMapEach(_:) which provides compactMap() semantics by allowing result values to be nil. Such results are not included in the output array.
func transform(to:)
Maps the current future to contain the new type. Errors are carried over, successful (expected) results are transformed into the given instance.
func tryFlatMap<NewValue>(file: StaticString, line: UInt, (Value) throws -> EventLoopFuture<NewValue>) -> EventLoopFuture<NewValue>

Topics

Operators

Instance Methods

Type Methods