Rename In to Event and Out to Output

Author: fabianfett

Sources/AWSLambdaRuntime/Lambda+Codable.swift

@@ -21,33 +21,33 @@ import NIOFoundationCompat
 
 // MARK: - Codable support
 
-/// Implementation of  a`ByteBuffer` to `In` decoding
-extension EventLoopLambdaHandler where In: Decodable {
+/// Implementation of  a`ByteBuffer` to `Event` decoding
+extension EventLoopLambdaHandler where Event: Decodable {
     @inlinable
-    public func decode(buffer: ByteBuffer) throws -> In {
-        try self.decoder.decode(In.self, from: buffer)
+    public func decode(buffer: ByteBuffer) throws -> Event {
+        try self.decoder.decode(Event.self, from: buffer)
     }
 }
 
-/// Implementation of  `Out` to `ByteBuffer` encoding
-extension EventLoopLambdaHandler where Out: Encodable {
+/// Implementation of  `Output` to `ByteBuffer` encoding
+extension EventLoopLambdaHandler where Output: Encodable {
     @inlinable
-    public func encode(allocator: ByteBufferAllocator, value: Out) throws -> ByteBuffer? {
+    public func encode(allocator: ByteBufferAllocator, value: Output) throws -> ByteBuffer? {
         try self.encoder.encode(value, using: allocator)
     }
 }
 
-/// Default `ByteBuffer` to `In` decoder using Foundation's JSONDecoder
+/// Default `ByteBuffer` to `Event` decoder using Foundation's JSONDecoder
 /// Advanced users that want to inject their own codec can do it by overriding these functions.
-extension EventLoopLambdaHandler where In: Decodable {
+extension EventLoopLambdaHandler where Event: Decodable {
     public var decoder: LambdaCodableDecoder {
         Lambda.defaultJSONDecoder
     }
 }
 
-/// Default `Out` to `ByteBuffer` encoder using Foundation's JSONEncoder
+/// Default `Output` to `ByteBuffer` encoder using Foundation's JSONEncoder
 /// Advanced users that want to inject their own codec can do it by overriding these functions.
-extension EventLoopLambdaHandler where Out: Encodable {
+extension EventLoopLambdaHandler where Output: Encodable {
     public var encoder: LambdaCodableEncoder {
         Lambda.defaultJSONEncoder
     }

Sources/AWSLambdaRuntimeCore/Lambda+String.swift

@@ -13,7 +13,7 @@
 //===----------------------------------------------------------------------===//
 import NIOCore
 
-extension EventLoopLambdaHandler where In == String {
+extension EventLoopLambdaHandler where Event == String {
     /// Implementation of a `ByteBuffer` to `String` decoding
     @inlinable
     public func decode(buffer: ByteBuffer) throws -> String {
@@ -25,7 +25,7 @@ extension EventLoopLambdaHandler where In == String {
     }
 }
 
-extension EventLoopLambdaHandler where Out == String {
+extension EventLoopLambdaHandler where Output == String {
     /// Implementation of `String` to `ByteBuffer` encoding
     @inlinable
     public func encode(allocator: ByteBufferAllocator, value: String) throws -> ByteBuffer? {

Sources/AWSLambdaRuntimeCore/LambdaHandler.swift

@@ -19,7 +19,7 @@ import NIOCore
 // MARK: - LambdaHandler
 
 #if compiler(>=5.5)
-/// Strongly typed, processing protocol for a Lambda that takes a user defined `In` and returns a user defined `Out` async.
+/// Strongly typed, processing protocol for a Lambda that takes a user defined `Event` and returns a user defined `Output` async.
 @available(macOS 12, iOS 15, tvOS 15, watchOS 8, *)
 public protocol LambdaHandler: EventLoopLambdaHandler {
     /// The Lambda initialization method
@@ -34,17 +34,17 @@ public protocol LambdaHandler: EventLoopLambdaHandler {
     /// Concrete Lambda handlers implement this method to provide the Lambda functionality.
     ///
     /// - parameters:
-    ///     - event: Event of type `In` representing the event or request.
+    ///     - event: Event of type `Event` representing the event or request.
     ///     - context: Runtime `Context`.
     ///
-    /// - Returns: A Lambda result ot type `Out`.
-    func handle(_ event: In, context: Lambda.Context) async throws -> Out
+    /// - Returns: A Lambda result ot type `Output`.
+    func handle(_ event: Event, context: Lambda.Context) async throws -> Output
 }
 
 @available(macOS 12, iOS 15, tvOS 15, watchOS 8, *)
 extension LambdaHandler {
-    public func handle(_ event: In, context: Lambda.Context) -> EventLoopFuture<Out> {
-        let promise = context.eventLoop.makePromise(of: Out.self)
+    public func handle(_ event: Event, context: Lambda.Context) -> EventLoopFuture<Output> {
+        let promise = context.eventLoop.makePromise(of: Output.self)
         promise.completeWithTask {
             try await self.handle(event, context: context)
         }
@@ -62,52 +62,52 @@ extension LambdaHandler {
 
 // MARK: - EventLoopLambdaHandler
 
-/// Strongly typed, `EventLoopFuture` based processing protocol for a Lambda that takes a user defined `In` and returns a user defined `Out` asynchronously.
-/// `EventLoopLambdaHandler` extends `ByteBufferLambdaHandler`, performing `ByteBuffer` -> `In` decoding and `Out` -> `ByteBuffer` encoding.
+/// Strongly typed, `EventLoopFuture` based processing protocol for a Lambda that takes a user defined `Event` and returns a user defined `Output` asynchronously.
+/// `EventLoopLambdaHandler` extends `ByteBufferLambdaHandler`, performing `ByteBuffer` -> `Event` decoding and `Output` -> `ByteBuffer` encoding.
 ///
 /// - note: To implement a Lambda, implement either `LambdaHandler` or the `EventLoopLambdaHandler` protocol.
 ///         The `LambdaHandler` will offload the Lambda execution to a `DispatchQueue` making processing safer but slower
 ///         The `EventLoopLambdaHandler` will execute the Lambda on the same `EventLoop` as the core runtime engine, making the processing faster but requires
 ///         more care from the implementation to never block the `EventLoop`.
 public protocol EventLoopLambdaHandler: ByteBufferLambdaHandler {
-    associatedtype In
-    associatedtype Out
+    associatedtype Event
+    associatedtype Output
 
     /// The Lambda handling method
     /// Concrete Lambda handlers implement this method to provide the Lambda functionality.
     ///
     /// - parameters:
     ///     - context: Runtime `Context`.
-    ///     - event: Event of type `In` representing the event or request.
+    ///     - event: Event of type `Event` representing the event or request.
     ///
     /// - Returns: An `EventLoopFuture` to report the result of the Lambda back to the runtime engine.
-    ///            The `EventLoopFuture` should be completed with either a response of type `Out` or an `Error`
-    func handle(_ event: In, context: Lambda.Context) -> EventLoopFuture<Out>
+    ///            The `EventLoopFuture` should be completed with either a response of type `Output` or an `Error`
+    func handle(_ event: Event, context: Lambda.Context) -> EventLoopFuture<Output>
 
-    /// Encode a response of type `Out` to `ByteBuffer`
+    /// Encode a response of type `Output` to `ByteBuffer`
     /// Concrete Lambda handlers implement this method to provide coding functionality.
     /// - parameters:
     ///     - allocator: A `ByteBufferAllocator` to help allocate the `ByteBuffer`.
-    ///     - value: Response of type `Out`.
+    ///     - value: Response of type `Output`.
     ///
     /// - Returns: A `ByteBuffer` with the encoded version of the `value`.
-    func encode(allocator: ByteBufferAllocator, value: Out) throws -> ByteBuffer?
+    func encode(allocator: ByteBufferAllocator, value: Output) throws -> ByteBuffer?
 
-    /// Decode a`ByteBuffer` to a request or event of type `In`
+    /// Decode a`ByteBuffer` to a request or event of type `Event`
     /// Concrete Lambda handlers implement this method to provide coding functionality.
     ///
     /// - parameters:
     ///     - buffer: The `ByteBuffer` to decode.
     ///
-    /// - Returns: A request or event of type `In`.
-    func decode(buffer: ByteBuffer) throws -> In
+    /// - Returns: A request or event of type `Event`.
+    func decode(buffer: ByteBuffer) throws -> Event
 }
 
 extension EventLoopLambdaHandler {
-    /// Driver for `ByteBuffer` -> `In` decoding and `Out` -> `ByteBuffer` encoding
+    /// Driver for `ByteBuffer` -> `Event` decoding and `Output` -> `ByteBuffer` encoding
     @inlinable
     public func handle(_ event: ByteBuffer, context: Lambda.Context) -> EventLoopFuture<ByteBuffer?> {
-        let input: In
+        let input: Event
         do {
             input = try self.decode(buffer: event)
         } catch {
@@ -125,7 +125,7 @@ extension EventLoopLambdaHandler {
 }
 
 /// Implementation of  `ByteBuffer` to `Void` decoding
-extension EventLoopLambdaHandler where Out == Void {
+extension EventLoopLambdaHandler where Output == Void {
     @inlinable
     public func encode(allocator: ByteBufferAllocator, value: Void) throws -> ByteBuffer? {
         nil

Sources/StringSample/main.swift

@@ -17,8 +17,8 @@ import NIOCore
 
 // in this example we are receiving and responding with strings
 struct Handler: EventLoopLambdaHandler {
-    typealias In = String
-    typealias Out = String
+    typealias Event = String
+    typealias Output = String
 
     func handle(_ event: String, context: Lambda.Context) -> EventLoopFuture<String> {
         // as an example, respond with the event's reversed body

Tests/AWSLambdaRuntimeTests/Lambda+CodeableTest.swift

@@ -38,8 +38,8 @@ class CodableLambdaTest: XCTestCase {
         var outputBuffer: ByteBuffer?
 
         struct Handler: EventLoopLambdaHandler {
-            typealias In = Request
-            typealias Out = Void
+            typealias Event = Request
+            typealias Output = Void
 
             let expected: Request
 
@@ -63,8 +63,8 @@ class CodableLambdaTest: XCTestCase {
         var response: Response?
 
         struct Handler: EventLoopLambdaHandler {
-            typealias In = Request
-            typealias Out = Response
+            typealias Event = Request
+            typealias Output = Response
 
             let expected: Request
 
@@ -86,8 +86,8 @@ class CodableLambdaTest: XCTestCase {
     @available(macOS 12, iOS 15, tvOS 15, watchOS 8, *)
     func testCodableVoidHandler() {
         struct Handler: LambdaHandler {
-            typealias In = Request
-            typealias Out = Void
+            typealias Event = Request
+            typealias Output = Void
 
             var expected: Request?
 
@@ -115,8 +115,8 @@ class CodableLambdaTest: XCTestCase {
     @available(macOS 12, iOS 15, tvOS 15, watchOS 8, *)
     func testCodableHandler() {
         struct Handler: LambdaHandler {
-            typealias In = Request
-            typealias Out = Response
+            typealias Event = Request
+            typealias Output = Response
 
             var expected: Request?