aws_smithy_runtime_api/client/interceptors/context/
wrappers.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */

use super::{Error, Input, InterceptorContext, Output};
use crate::client::interceptors::context::{Request, Response};
use crate::client::orchestrator::OrchestratorError;
use std::fmt::Debug;

macro_rules! impl_from_interceptor_context {
    (ref $wrapper:ident) => {
        impl<'a, I, O, E> From<&'a InterceptorContext<I, O, E>> for $wrapper<'a, I, O, E> {
            fn from(inner: &'a InterceptorContext<I, O, E>) -> Self {
                Self { inner }
            }
        }
    };
    (mut $wrapper:ident) => {
        impl<'a, I, O, E> From<&'a mut InterceptorContext<I, O, E>> for $wrapper<'a, I, O, E> {
            fn from(inner: &'a mut InterceptorContext<I, O, E>) -> Self {
                Self { inner }
            }
        }
    };
}

macro_rules! expect {
    ($self:ident, $what:ident) => {
        $self.inner.$what().expect(concat!(
            "`",
            stringify!($what),
            "` wasn't set in the underlying interceptor context. This is a bug."
        ))
    };
}

//
// BeforeSerializationInterceptorContextRef
//

/// Interceptor context for the `read_before_execution` and `read_before_serialization` hooks.
///
/// Only the input is available at this point in the operation.
#[derive(Debug)]
pub struct BeforeSerializationInterceptorContextRef<'a, I = Input, O = Output, E = Error> {
    inner: &'a InterceptorContext<I, O, E>,
}

impl_from_interceptor_context!(ref BeforeSerializationInterceptorContextRef);

impl<'a, I, O, E> BeforeSerializationInterceptorContextRef<'a, I, O, E> {
    /// Returns a reference to the input.
    pub fn input(&self) -> &I {
        expect!(self, input)
    }

    /// Downgrade this wrapper struct, returning the underlying InterceptorContext.
    ///
    /// There's no good reason to use this unless you're writing tests or you have to
    /// interact with an API that doesn't support the context wrapper structs.
    pub fn inner(&self) -> &'_ InterceptorContext<I, O, E> {
        self.inner
    }
}

//
// BeforeSerializationInterceptorContextMut
//

/// Interceptor context for the `modify_before_serialization` hook.
///
/// Only the input is available at this point in the operation.
#[derive(Debug)]
pub struct BeforeSerializationInterceptorContextMut<'a, I = Input, O = Output, E = Error> {
    inner: &'a mut InterceptorContext<I, O, E>,
}

impl_from_interceptor_context!(mut BeforeSerializationInterceptorContextMut);

impl<'a, I, O, E> BeforeSerializationInterceptorContextMut<'a, I, O, E> {
    /// Returns a reference to the input.
    pub fn input(&self) -> &I {
        expect!(self, input)
    }

    /// Returns a mutable reference to the input.
    pub fn input_mut(&mut self) -> &mut I {
        expect!(self, input_mut)
    }

    /// Downgrade this wrapper struct, returning the underlying InterceptorContext.
    ///
    /// There's no good reason to use this unless you're writing tests or you have to
    /// interact with an API that doesn't support the context wrapper structs.
    pub fn inner(&self) -> &'_ InterceptorContext<I, O, E> {
        self.inner
    }

    /// Downgrade this wrapper struct, returning the underlying InterceptorContext.
    ///
    /// There's no good reason to use this unless you're writing tests or you have to
    /// interact with an API that doesn't support the context wrapper structs.
    pub fn inner_mut(&mut self) -> &'_ mut InterceptorContext<I, O, E> {
        self.inner
    }
}

//
// BeforeSerializationInterceptorContextRef
//

/// Interceptor context for several hooks in between serialization and transmission.
///
/// Only the request is available at this point in the operation.
#[derive(Debug)]
pub struct BeforeTransmitInterceptorContextRef<'a, I = Input, O = Output, E = Error> {
    inner: &'a InterceptorContext<I, O, E>,
}

impl_from_interceptor_context!(ref BeforeTransmitInterceptorContextRef);

impl<'a, I, O, E> BeforeTransmitInterceptorContextRef<'a, I, O, E> {
    /// Returns a reference to the transmittable request for the operation being invoked.
    pub fn request(&self) -> &Request {
        expect!(self, request)
    }

    /// Downgrade this wrapper struct, returning the underlying InterceptorContext.
    ///
    /// There's no good reason to use this unless you're writing tests or you have to
    /// interact with an API that doesn't support the context wrapper structs.
    pub fn inner(&self) -> &'_ InterceptorContext<I, O, E> {
        self.inner
    }
}

//
// BeforeSerializationInterceptorContextMut
//

/// Interceptor context for several hooks in between serialization and transmission.
///
/// Only the request is available at this point in the operation.
#[derive(Debug)]
pub struct BeforeTransmitInterceptorContextMut<'a, I = Input, O = Output, E = Error> {
    inner: &'a mut InterceptorContext<I, O, E>,
}

impl_from_interceptor_context!(mut BeforeTransmitInterceptorContextMut);

impl<'a, I, O, E> BeforeTransmitInterceptorContextMut<'a, I, O, E> {
    /// Returns a reference to the transmittable request for the operation being invoked.
    pub fn request(&self) -> &Request {
        expect!(self, request)
    }

    /// Returns a mutable reference to the transmittable request for the operation being invoked.
    pub fn request_mut(&mut self) -> &mut Request {
        expect!(self, request_mut)
    }

    /// Downgrade this wrapper struct, returning the underlying InterceptorContext.
    ///
    /// There's no good reason to use this unless you're writing tests or you have to
    /// interact with an API that doesn't support the context wrapper structs.
    pub fn inner(&self) -> &'_ InterceptorContext<I, O, E> {
        self.inner
    }

    /// Downgrade this wrapper struct, returning the underlying InterceptorContext.
    ///
    /// There's no good reason to use this unless you're writing tests or you have to
    /// interact with an API that doesn't support the context wrapper structs.
    pub fn inner_mut(&mut self) -> &'_ mut InterceptorContext<I, O, E> {
        self.inner
    }
}

//
// BeforeDeserializationInterceptorContextRef
//

/// Interceptor context for hooks before deserializing the response.
///
/// Only the response is available at this point in the operation.
#[derive(Debug)]
pub struct BeforeDeserializationInterceptorContextRef<'a, I = Input, O = Output, E = Error> {
    inner: &'a InterceptorContext<I, O, E>,
}

impl_from_interceptor_context!(ref BeforeDeserializationInterceptorContextRef);

impl<'a, I, O, E> BeforeDeserializationInterceptorContextRef<'a, I, O, E> {
    /// Returns a reference to the response.
    pub fn response(&self) -> &Response {
        expect!(self, response)
    }

    /// Downgrade this wrapper struct, returning the underlying InterceptorContext.
    ///
    /// There's no good reason to use this unless you're writing tests or you have to
    /// interact with an API that doesn't support the context wrapper structs.
    pub fn inner(&self) -> &'_ InterceptorContext<I, O, E> {
        self.inner
    }
}

//
// BeforeDeserializationInterceptorContextMut
//

/// Interceptor context for hooks before deserializing the response.
///
/// Only the response is available at this point in the operation.
pub struct BeforeDeserializationInterceptorContextMut<'a, I = Input, O = Output, E = Error> {
    inner: &'a mut InterceptorContext<I, O, E>,
}

impl_from_interceptor_context!(mut BeforeDeserializationInterceptorContextMut);

impl<'a, I, O, E> BeforeDeserializationInterceptorContextMut<'a, I, O, E> {
    /// Returns a reference to the response.
    pub fn response(&self) -> &Response {
        expect!(self, response)
    }

    /// Returns a mutable reference to the response.
    pub fn response_mut(&mut self) -> &mut Response {
        expect!(self, response_mut)
    }

    /// Downgrade this wrapper struct, returning the underlying InterceptorContext.
    ///
    /// There's no good reason to use this unless you're writing tests or you have to
    /// interact with an API that doesn't support the context wrapper structs.
    pub fn inner(&self) -> &'_ InterceptorContext<I, O, E> {
        self.inner
    }

    /// Downgrade this wrapper struct, returning the underlying InterceptorContext.
    ///
    /// There's no good reason to use this unless you're writing tests or you have to
    /// interact with an API that doesn't support the context wrapper structs.
    pub fn inner_mut(&mut self) -> &'_ mut InterceptorContext<I, O, E> {
        self.inner
    }
}

//
// AfterDeserializationInterceptorContextRef
//

/// Interceptor context for hooks after deserializing the response.
///
/// The response and the deserialized output or error are available at this point in the operation.
pub struct AfterDeserializationInterceptorContextRef<'a, I = Input, O = Output, E = Error> {
    inner: &'a InterceptorContext<I, O, E>,
}

impl_from_interceptor_context!(ref AfterDeserializationInterceptorContextRef);

impl<'a, I, O, E> AfterDeserializationInterceptorContextRef<'a, I, O, E> {
    /// Returns a reference to the response.
    pub fn response(&self) -> &Response {
        expect!(self, response)
    }

    /// Returns a reference to the deserialized output or error.
    pub fn output_or_error(&self) -> Result<&O, &OrchestratorError<E>> {
        expect!(self, output_or_error)
    }

    /// Downgrade this wrapper struct, returning the underlying InterceptorContext.
    ///
    /// There's no good reason to use this unless you're writing tests or you have to
    /// interact with an API that doesn't support the context wrapper structs.
    pub fn inner(&self) -> &'_ InterceptorContext<I, O, E> {
        self.inner
    }
}

//
// FinalizerInterceptorContextRef
//

/// Interceptor context for finalization hooks.
///
/// This context is used by the `read_after_attempt` and `read_after_execution` hooks
/// that are all called upon both success and failure, and may have varying levels
/// of context available depending on where a failure occurred if the operation failed.
pub struct FinalizerInterceptorContextRef<'a, I = Input, O = Output, E = Error> {
    inner: &'a InterceptorContext<I, O, E>,
}

impl_from_interceptor_context!(ref FinalizerInterceptorContextRef);

impl<'a, I, O, E> FinalizerInterceptorContextRef<'a, I, O, E> {
    /// Returns the operation input.
    pub fn input(&self) -> Option<&I> {
        self.inner.input.as_ref()
    }

    /// Returns the serialized request.
    pub fn request(&self) -> Option<&Request> {
        self.inner.request.as_ref()
    }

    /// Returns the raw response.
    pub fn response(&self) -> Option<&Response> {
        self.inner.response.as_ref()
    }

    /// Returns the deserialized operation output or error.
    pub fn output_or_error(&self) -> Option<Result<&O, &OrchestratorError<E>>> {
        self.inner.output_or_error.as_ref().map(|o| o.as_ref())
    }

    /// Downgrade this wrapper struct, returning the underlying InterceptorContext.
    ///
    /// There's no good reason to use this unless you're writing tests or you have to
    /// interact with an API that doesn't support the context wrapper structs.
    pub fn inner(&self) -> &'_ InterceptorContext<I, O, E> {
        self.inner
    }
}

//
// FinalizerInterceptorContextMut
//

/// Interceptor context for finalization hooks.
///
/// This context is used by the `modify_before_attempt_completion` and `modify_before_completion` hooks
/// that are all called upon both success and failure, and may have varying levels
/// of context available depending on where a failure occurred if the operation failed.
pub struct FinalizerInterceptorContextMut<'a, I = Input, O = Output, E = Error> {
    inner: &'a mut InterceptorContext<I, O, E>,
}

impl_from_interceptor_context!(mut FinalizerInterceptorContextMut);

impl<'a, I, O, E> FinalizerInterceptorContextMut<'a, I, O, E> {
    /// Returns the operation input.
    pub fn input(&self) -> Option<&I> {
        self.inner.input.as_ref()
    }

    /// Returns the serialized request.
    pub fn request(&self) -> Option<&Request> {
        self.inner.request.as_ref()
    }

    /// Returns the raw response.
    pub fn response(&self) -> Option<&Response> {
        self.inner.response.as_ref()
    }

    /// Returns the deserialized operation output or error.
    pub fn output_or_error(&self) -> Option<Result<&O, &OrchestratorError<E>>> {
        self.inner.output_or_error.as_ref().map(|o| o.as_ref())
    }

    /// Mutably returns the operation input.
    pub fn input_mut(&mut self) -> Option<&mut I> {
        self.inner.input.as_mut()
    }

    /// Mutably returns the serialized request.
    pub fn request_mut(&mut self) -> Option<&mut Request> {
        self.inner.request.as_mut()
    }

    /// Mutably returns the raw response.
    pub fn response_mut(&mut self) -> Option<&mut Response> {
        self.inner.response.as_mut()
    }

    /// Mutably returns the deserialized operation output or error.
    pub fn output_or_error_mut(&mut self) -> Option<&mut Result<O, OrchestratorError<E>>> {
        self.inner.output_or_error.as_mut()
    }

    /// Downgrade this wrapper struct, returning the underlying InterceptorContext.
    ///
    /// There's no good reason to use this unless you're writing tests or you have to
    /// interact with an API that doesn't support the context wrapper structs.
    pub fn inner(&self) -> &'_ InterceptorContext<I, O, E> {
        self.inner
    }

    /// Downgrade this wrapper struct, returning the underlying InterceptorContext.
    ///
    /// There's no good reason to use this unless you're writing tests or you have to
    /// interact with an API that doesn't support the context wrapper structs.
    pub fn inner_mut(&mut self) -> &'_ mut InterceptorContext<I, O, E> {
        self.inner
    }
}