pub struct RequestBuilderParts<'r> { /* private fields */ }
Expand description

HTTP 请求构建器部分参数

包含 HTTP 请求构建器内除请求体和终端地址提供者以外的参数

Implementations§

设置是否使用 HTTPS

Examples found in repository?
src/client/request/builder.rs (line 363)
362
363
364
365
    pub fn use_https(&mut self, use_https: bool) -> &mut Self {
        self.parts.use_https(use_https);
        self
    }

设置 HTTP 协议版本

Examples found in repository?
src/client/request/builder.rs (line 370)
369
370
371
372
    pub fn version(&mut self, version: Version) -> &mut Self {
        self.parts.version(version);
        self
    }

设置 HTTP 请求路径

Examples found in repository?
src/client/request/builder.rs (line 377)
376
377
378
379
    pub fn path(&mut self, path: impl Into<Cow<'r, str>>) -> &mut Self {
        self.parts.path(path);
        self
    }

设置 HTTP 请求头

Examples found in repository?
src/client/request/builder.rs (line 384)
383
384
385
386
    pub fn headers(&mut self, headers: impl Into<Cow<'r, HeaderMap>>) -> &mut Self {
        self.parts.headers(headers);
        self
    }

添加 HTTP 请求头

Examples found in repository?
src/client/request/builder.rs (lines 89-92)
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
    fn set_content_type(&mut self, content_type: Option<Mime>) -> &mut Self {
        self.set_header(
            CONTENT_TYPE,
            HeaderValue::from_str(content_type.as_ref().unwrap_or(&APPLICATION_OCTET_STREAM).as_ref()).unwrap(),
        )
    }

    /// 设置 HTTP 响应预期为 JSON 类型
    #[inline]
    pub fn accept_json(&mut self) -> &mut Self {
        self.set_accept(APPLICATION_JSON)
    }

    /// 设置 HTTP 响应预期为二进制流类型
    #[inline]
    pub fn accept_application_octet_stream(&mut self) -> &mut Self {
        self.set_accept(APPLICATION_OCTET_STREAM)
    }

    fn set_accept(&mut self, accept: Mime) -> &mut Self {
        self.set_header(ACCEPT, HeaderValue::from_str(accept.as_ref()).unwrap())
    }

    /// 设置查询参数
    #[inline]
    pub fn query(&mut self, query: impl Into<Cow<'r, str>>) -> &mut Self {
        self.metadata.query = query.into();
        self
    }

    /// 设置查询参数
    #[inline]
    pub fn query_pairs(&mut self, query_pairs: impl Into<Vec<QueryPair<'r>>>) -> &mut Self {
        self.metadata.query_pairs = query_pairs.into();
        self
    }

    /// 追加查询参数
    #[inline]
    pub fn append_query_pair(
        &mut self,
        query_pair_key: impl Into<QueryPairKey<'r>>,
        query_pair_value: impl Into<QueryPairValue<'r>>,
    ) -> &mut Self {
        self.metadata
            .query_pairs
            .push((query_pair_key.into(), query_pair_value.into()));
        self
    }

    /// 追加 UserAgent
    #[inline]
    pub fn appended_user_agent(&mut self, user_agent: impl Into<UserAgent>) -> &mut Self {
        self.appended_user_agent = user_agent.into();
        self
    }

    /// 设置鉴权签名
    #[inline]
    pub fn authorization(&mut self, authorization: Authorization<'r>) -> &mut Self {
        self.metadata.authorization = Some(authorization);
        self
    }

    /// 设置为幂等请求
    #[inline]
    pub fn idempotent(&mut self, idempotent: Idempotent) -> &mut Self {
        self.metadata.idempotent = idempotent;
        self
    }

    /// 设置扩展信息
    #[inline]
    pub fn extensions(&mut self, extensions: Extensions) -> &mut Self {
        self.extensions = extensions;
        self
    }

    /// 添加扩展信息
    #[inline]
    pub fn add_extension<T: Send + Sync + 'static>(&mut self, val: T) -> &mut Self {
        self.extensions.insert(val);
        self
    }

    /// 设置上传进度回调函数
    #[inline]
    pub fn on_uploading_progress(
        &mut self,
        callback: impl Fn(&dyn SimplifiedCallbackContext, TransferProgressInfo<'_>) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.callbacks.on_uploading_progress(callback);
        self
    }

    /// 设置响应状态码回调函数
    #[inline]

    pub fn on_receive_response_status(
        &mut self,
        callback: impl Fn(&dyn SimplifiedCallbackContext, StatusCode) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.callbacks.on_receive_response_status(callback);
        self
    }

    /// 设置响应 HTTP 头回调函数
    #[inline]
    pub fn on_receive_response_header(
        &mut self,
        callback: impl Fn(&dyn SimplifiedCallbackContext, &HeaderName, &HeaderValue) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.callbacks.on_receive_response_header(callback);
        self
    }

    /// 设置域名解析前回调函数
    #[inline]
    pub fn on_to_resolve_domain(
        &mut self,
        callback: impl Fn(&mut dyn CallbackContext, &str) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.callbacks.on_to_resolve_domain(callback);
        self
    }

    /// 设置域名解析成功回调函数
    #[inline]
    pub fn on_domain_resolved(
        &mut self,
        callback: impl Fn(&mut dyn CallbackContext, &str, &ResolveAnswers) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.callbacks.on_domain_resolved(callback);
        self
    }

    /// 设置 IP 地址选择前回调函数
    #[inline]
    pub fn on_to_choose_ips(
        &mut self,
        callback: impl Fn(&mut dyn CallbackContext, &[IpAddrWithPort]) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.callbacks.on_to_choose_ips(callback);
        self
    }

    /// 设置 IP 地址选择成功回调函数
    #[inline]
    pub fn on_ips_chosen(
        &mut self,
        callback: impl Fn(&mut dyn CallbackContext, &[IpAddrWithPort], &[IpAddrWithPort]) -> AnyResult<()>
            + Send
            + Sync
            + 'r,
    ) -> &mut Self {
        self.callbacks.on_ips_chosen(callback);
        self
    }

    /// 设置 HTTP 请求签名前回调函数
    #[inline]
    pub fn on_before_request_signed(
        &mut self,
        callback: impl Fn(&mut dyn ExtendedCallbackContext) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.callbacks.on_before_request_signed(callback);
        self
    }

    /// 设置 HTTP 请求前回调函数
    #[inline]
    pub fn on_after_request_signed(
        &mut self,
        callback: impl Fn(&mut dyn ExtendedCallbackContext) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.callbacks.on_after_request_signed(callback);
        self
    }

    /// 设置响应成功回调函数
    #[inline]
    pub fn on_response(
        &mut self,
        callback: impl Fn(&mut dyn ExtendedCallbackContext, &ResponseParts) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.callbacks.on_response(callback);
        self
    }

    /// 设置响应错误回调函数
    #[inline]
    pub fn on_error(
        &mut self,
        callback: impl Fn(&mut dyn ExtendedCallbackContext, &mut ResponseError) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.callbacks.on_error(callback);
        self
    }

    /// 设置退避前回调函数
    #[inline]
    pub fn on_before_backoff(
        &mut self,
        callback: impl Fn(&mut dyn ExtendedCallbackContext, Duration) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.callbacks.on_before_backoff(callback);
        self
    }

    /// 设置退避后回调函数
    #[inline]
    pub fn on_after_backoff(
        &mut self,
        callback: impl Fn(&mut dyn ExtendedCallbackContext, Duration) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.callbacks.on_after_backoff(callback);
        self
    }

    /// 构建为请求部分参数
    #[inline]
    pub fn build(self) -> RequestParts<'r> {
        RequestParts {
            metadata: self.metadata,
            extensions: self.extensions,
            appended_user_agent: self.appended_user_agent,
        }
    }

    #[allow(dead_code)]
    fn ignore() {
        assert_impl!(Send: Self);
        assert_impl!(Sync: Self);
    }
}

/// 请求构建器
///
/// 通过 [`HttpClient::get`], [`HttpClient::post`] 等方法创建请求构建器
#[derive(Debug)]
pub struct RequestBuilder<'r, B: 'r, E: 'r> {
    http_client: &'r HttpClient,
    service_names: &'r [ServiceName],
    endpoints_provider: E,
    parts: RequestBuilderParts<'r>,
    body: B,
}

impl<'r, B: Default + 'r, E: EndpointsProvider + 'r> RequestBuilder<'r, B, E> {
    pub(in super::super) fn new(
        http_client: &'r HttpClient,
        method: Method,
        endpoints_provider: E,
        service_names: &'r [ServiceName],
    ) -> Self {
        Self {
            http_client,
            service_names,
            endpoints_provider,
            parts: RequestBuilderParts {
                metadata: RequestMetadata {
                    method,
                    ..Default::default()
                },
                ..Default::default()
            },
            body: Default::default(),
        }
    }
}

impl<'r, B: 'r, E: 'r> RequestBuilder<'r, B, E> {
    /// 设置是否使用 HTTPS
    #[inline]
    pub fn use_https(&mut self, use_https: bool) -> &mut Self {
        self.parts.use_https(use_https);
        self
    }

    /// 设置 HTTP 协议版本
    #[inline]
    pub fn version(&mut self, version: Version) -> &mut Self {
        self.parts.version(version);
        self
    }

    /// 设置 HTTP 请求路径
    #[inline]
    pub fn path(&mut self, path: impl Into<Cow<'r, str>>) -> &mut Self {
        self.parts.path(path);
        self
    }

    /// 设置 HTTP 请求头
    #[inline]
    pub fn headers(&mut self, headers: impl Into<Cow<'r, HeaderMap>>) -> &mut Self {
        self.parts.headers(headers);
        self
    }

    /// 添加 HTTP 请求头
    #[inline]
    pub fn set_header(&mut self, header_name: impl IntoHeaderName, header_value: impl Into<HeaderValue>) -> &mut Self {
        self.parts.set_header(header_name, header_value);
        self
    }

设置 HTTP 响应预期为 JSON 类型

Examples found in repository?
src/client/request/builder.rs (line 398)
397
398
399
400
    pub fn accept_json(&mut self) -> &mut Self {
        self.parts.accept_json();
        self
    }

设置 HTTP 响应预期为二进制流类型

Examples found in repository?
src/client/request/builder.rs (line 405)
404
405
406
407
    pub fn accept_application_octet_stream(&mut self) -> &mut Self {
        self.parts.accept_application_octet_stream();
        self
    }

设置查询参数

Examples found in repository?
src/client/request/builder.rs (line 412)
411
412
413
414
    pub fn query(&mut self, query: impl Into<Cow<'r, str>>) -> &mut Self {
        self.parts.query(query);
        self
    }

设置查询参数

Examples found in repository?
src/client/request/builder.rs (line 419)
418
419
420
421
    pub fn query_pairs(&mut self, query_pairs: impl Into<Vec<QueryPair<'r>>>) -> &mut Self {
        self.parts.query_pairs(query_pairs);
        self
    }

追加查询参数

Examples found in repository?
src/client/request/builder.rs (line 430)
425
426
427
428
429
430
431
432
    pub fn append_query_pair(
        &mut self,
        query_pair_key: impl Into<QueryPairKey<'r>>,
        query_pair_value: impl Into<QueryPairValue<'r>>,
    ) -> &mut Self {
        self.parts.append_query_pair(query_pair_key, query_pair_value);
        self
    }

追加 UserAgent

Examples found in repository?
src/client/request/builder.rs (line 437)
436
437
438
439
    pub fn appended_user_agent(&mut self, user_agent: impl Into<UserAgent>) -> &mut Self {
        self.parts.appended_user_agent(user_agent);
        self
    }

设置鉴权签名

Examples found in repository?
src/client/request/builder.rs (line 444)
443
444
445
446
    pub fn authorization(&mut self, authorization: Authorization<'r>) -> &mut Self {
        self.parts.authorization(authorization);
        self
    }

设置为幂等请求

Examples found in repository?
src/client/request/builder.rs (line 451)
450
451
452
453
    pub fn idempotent(&mut self, idempotent: Idempotent) -> &mut Self {
        self.parts.idempotent(idempotent);
        self
    }

设置扩展信息

Examples found in repository?
src/client/request/builder.rs (line 458)
457
458
459
460
    pub fn extensions(&mut self, extensions: Extensions) -> &mut Self {
        self.parts.extensions(extensions);
        self
    }

添加扩展信息

Examples found in repository?
src/client/request/builder.rs (line 465)
464
465
466
467
    pub fn add_extension<T: Send + Sync + 'static>(&mut self, val: T) -> &mut Self {
        self.parts.add_extension(val);
        self
    }

设置上传进度回调函数

Examples found in repository?
src/client/request/builder.rs (line 475)
471
472
473
474
475
476
477
    pub fn on_uploading_progress(
        &mut self,
        callback: impl Fn(&dyn SimplifiedCallbackContext, TransferProgressInfo<'_>) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.parts.on_uploading_progress(callback);
        self
    }

设置响应状态码回调函数

Examples found in repository?
src/client/request/builder.rs (line 485)
481
482
483
484
485
486
487
    pub fn on_receive_response_status(
        &mut self,
        callback: impl Fn(&dyn SimplifiedCallbackContext, StatusCode) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.parts.on_receive_response_status(callback);
        self
    }

设置响应 HTTP 头回调函数

Examples found in repository?
src/client/request/builder.rs (line 495)
491
492
493
494
495
496
497
    pub fn on_receive_response_header(
        &mut self,
        callback: impl Fn(&dyn SimplifiedCallbackContext, &HeaderName, &HeaderValue) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.parts.on_receive_response_header(callback);
        self
    }

设置域名解析前回调函数

Examples found in repository?
src/client/request/builder.rs (line 505)
501
502
503
504
505
506
507
    pub fn on_to_resolve_domain(
        &mut self,
        callback: impl Fn(&mut dyn CallbackContext, &str) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.parts.on_to_resolve_domain(callback);
        self
    }

设置域名解析成功回调函数

Examples found in repository?
src/client/request/builder.rs (line 515)
511
512
513
514
515
516
517
    pub fn on_domain_resolved(
        &mut self,
        callback: impl Fn(&mut dyn CallbackContext, &str, &ResolveAnswers) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.parts.on_domain_resolved(callback);
        self
    }

设置 IP 地址选择前回调函数

Examples found in repository?
src/client/request/builder.rs (line 525)
521
522
523
524
525
526
527
    pub fn on_to_choose_ips(
        &mut self,
        callback: impl Fn(&mut dyn CallbackContext, &[IpAddrWithPort]) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.parts.on_to_choose_ips(callback);
        self
    }

设置 IP 地址选择成功回调函数

Examples found in repository?
src/client/request/builder.rs (line 538)
531
532
533
534
535
536
537
538
539
540
    pub fn on_ips_chosen(
        &mut self,
        callback: impl Fn(&mut dyn CallbackContext, &[IpAddrWithPort], &[IpAddrWithPort]) -> AnyResult<()>
            + Send
            + Sync
            + 'r,
    ) -> &mut Self {
        self.parts.on_ips_chosen(callback);
        self
    }

设置 HTTP 请求签名前回调函数

Examples found in repository?
src/client/request/builder.rs (line 548)
544
545
546
547
548
549
550
    pub fn on_before_request_signed(
        &mut self,
        callback: impl Fn(&mut dyn ExtendedCallbackContext) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.parts.on_before_request_signed(callback);
        self
    }

设置 HTTP 请求前回调函数

Examples found in repository?
src/client/request/builder.rs (line 558)
554
555
556
557
558
559
560
    pub fn on_after_request_signed(
        &mut self,
        callback: impl Fn(&mut dyn ExtendedCallbackContext) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.parts.on_after_request_signed(callback);
        self
    }

设置响应成功回调函数

Examples found in repository?
src/client/request/builder.rs (line 568)
564
565
566
567
568
569
570
    pub fn on_response(
        &mut self,
        callback: impl Fn(&mut dyn ExtendedCallbackContext, &ResponseParts) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.parts.on_response(callback);
        self
    }

设置响应错误回调函数

Examples found in repository?
src/client/request/builder.rs (line 578)
574
575
576
577
578
579
580
    pub fn on_error(
        &mut self,
        callback: impl Fn(&mut dyn ExtendedCallbackContext, &mut ResponseError) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.parts.on_error(callback);
        self
    }

设置退避前回调函数

Examples found in repository?
src/client/request/builder.rs (line 588)
584
585
586
587
588
589
590
    pub fn on_before_backoff(
        &mut self,
        callback: impl Fn(&mut dyn ExtendedCallbackContext, Duration) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.parts.on_before_backoff(callback);
        self
    }

设置退避后回调函数

Examples found in repository?
src/client/request/builder.rs (line 598)
594
595
596
597
598
599
600
    pub fn on_after_backoff(
        &mut self,
        callback: impl Fn(&mut dyn ExtendedCallbackContext, Duration) -> AnyResult<()> + Send + Sync + 'r,
    ) -> &mut Self {
        self.parts.on_after_backoff(callback);
        self
    }

构建为请求部分参数

Trait Implementations§

Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Converts self into T using Into<T>. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Pipes by value. This is generally the method you want to use. Read more
Borrows self and passes that borrow into the pipe function. Read more
Mutably borrows self and passes that borrow into the pipe function. Read more
Borrows self, then passes self.borrow() into the pipe function. Read more
Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Borrows self, then passes self.as_ref() into the pipe function.
Mutably borrows self, then passes self.as_mut() into the pipe function.
Borrows self, then passes self.deref() into the pipe function.
Mutably borrows self, then passes self.deref_mut() into the pipe function.
Should always be Self
Immutable access to a value. Read more
Mutable access to a value. Read more
Immutable access to the Borrow<B> of a value. Read more
Mutable access to the BorrowMut<B> of a value. Read more
Immutable access to the AsRef<R> view of a value. Read more
Mutable access to the AsMut<R> view of a value. Read more
Immutable access to the Deref::Target of a value. Read more
Mutable access to the Deref::Target of a value. Read more
Calls .tap() only in debug builds, and is erased in release builds.
Calls .tap_mut() only in debug builds, and is erased in release builds.
Calls .tap_borrow() only in debug builds, and is erased in release builds.
Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Calls .tap_ref() only in debug builds, and is erased in release builds.
Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Calls .tap_deref() only in debug builds, and is erased in release builds.
Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Attempts to convert self into T using TryInto<T>. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more