You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Sources/AWSLambdaRuntimeCore/Lambda+Codable.swift
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -15,9 +15,9 @@
15
15
import NIOCore
16
16
17
17
/// The protocol a decoder must conform to so that it can be used with ``LambdaCodableAdapter`` to decode incoming
18
-
/// ``ByteBuffer`` events.
18
+
/// `ByteBuffer` events.
19
19
publicprotocolLambdaEventDecoder{
20
-
/// Decode the ``ByteBuffer`` representing the received event into the generic ``Event`` type
20
+
/// Decode the `ByteBuffer` representing the received event into the generic `Event` type
21
21
/// the handler will receive.
22
22
/// - Parameters:
23
23
/// - type: The type of the object to decode the buffer into.
@@ -27,14 +27,14 @@ public protocol LambdaEventDecoder {
27
27
}
28
28
29
29
/// The protocol an encoder must conform to so that it can be used with ``LambdaCodableAdapter`` to encode the generic
30
-
/// ``Output`` object into a ``ByteBuffer``.
30
+
/// ``LambdaOutputEncoder/Output`` object into a `ByteBuffer`.
31
31
publicprotocolLambdaOutputEncoder{
32
32
associatedtypeOutput
33
33
34
-
/// Encode the generic type `Output` the handler has returned into a ``ByteBuffer``.
34
+
/// Encode the generic type `Output` the handler has returned into a `ByteBuffer`.
35
35
/// - Parameters:
36
-
/// - value: The object to encode into a ``ByteBuffer``.
37
-
/// - buffer: The ``ByteBuffer`` where the encoded value will be written to.
36
+
/// - value: The object to encode into a `ByteBuffer`.
37
+
/// - buffer: The `ByteBuffer` where the encoded value will be written to.
38
38
func encode(_ value:Output, into buffer:inoutByteBuffer)throws
39
39
}
40
40
@@ -62,7 +62,7 @@ public struct LambdaHandlerAdapter<
62
62
self.handler = handler
63
63
}
64
64
65
-
/// Passes the generic ``Event`` object to the ``LambdaHandler/handle(_:context:)`` function, and
65
+
/// Passes the generic `Event` object to the ``LambdaHandler/handle(_:context:)`` function, and
66
66
/// the resulting output is then written to ``LambdaWithBackgroundProcessingHandler``'s `outputWriter`.
67
67
/// - Parameters:
68
68
/// - event: The received event.
@@ -94,8 +94,8 @@ public struct LambdaCodableAdapter<
94
94
95
95
/// Initializes an instance given an encoder, decoder, and a handler with a non-`Void` output.
96
96
/// - Parameters:
97
-
/// - encoder: The encoder object that will be used to encode the generic ``Output`` obtained from the `handler`'s `outputWriter` into a ``ByteBuffer``.
98
-
/// - decoder: The decoder object that will be used to decode the received ``ByteBuffer`` event into the generic ``Event`` type served to the `handler`.
97
+
/// - encoder: The encoder object that will be used to encode the generic `Output` obtained from the `handler`'s `outputWriter` into a `ByteBuffer`.
98
+
/// - decoder: The decoder object that will be used to decode the received `ByteBuffer` event into the generic `Event` type served to the `handler`.
@@ -106,7 +106,7 @@ public struct LambdaCodableAdapter<
106
106
107
107
/// Initializes an instance given a decoder, and a handler with a `Void` output.
108
108
/// - Parameters:
109
-
/// - decoder: The decoder object that will be used to decode the received ``ByteBuffer`` event into the generic ``Event`` type served to the `handler`.
109
+
/// - decoder: The decoder object that will be used to decode the received `ByteBuffer` event into the generic ``Event`` type served to the `handler`.
@@ -145,7 +145,7 @@ where Output == Encoder.Output {
145
145
146
146
/// Initializes an instance given an encoder and an underlying ``LambdaResponseStreamWriter``.
147
147
/// - Parameters:
148
-
/// - encoder: The encoder object that will be used to encode the generic ``Output`` into a ``ByteBuffer``, which will then be passed to `streamWriter`.
148
+
/// - encoder: The encoder object that will be used to encode the generic `Output` into a `ByteBuffer`, which will then be passed to `streamWriter`.
149
149
/// - streamWriter: The underlying ``LambdaResponseStreamWriter`` that will be wrapped.
0 commit comments