Struct RequestBuilder

Source
pub struct RequestBuilder<'r, B: 'r, E: 'r> { /* private fields */ }
Expand description

请求构建器

通过 HttpClient::getHttpClient::post 等方法创建请求构建器

Implementations§

Source§

impl<'r, B: 'r, E: 'r> RequestBuilder<'r, B, E>

Source

pub fn use_https(&mut self, use_https: bool) -> &mut Self

设置是否使用 HTTPS

Source

pub fn version(&mut self, version: Version) -> &mut Self

设置 HTTP 协议版本

Source

pub fn path(&mut self, path: impl Into<Cow<'r, str>>) -> &mut Self

设置 HTTP 请求路径

Source

pub fn headers(&mut self, headers: impl Into<Cow<'r, HeaderMap>>) -> &mut Self

设置 HTTP 请求头

Source

pub fn set_header( &mut self, header_name: impl IntoHeaderName, header_value: impl Into<HeaderValue>, ) -> &mut Self

添加 HTTP 请求头

Source

pub fn accept_json(&mut self) -> &mut Self

设置 HTTP 响应预期为 JSON 类型

Source

pub fn accept_application_octet_stream(&mut self) -> &mut Self

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

Source

pub fn query(&mut self, query: impl Into<Cow<'r, str>>) -> &mut Self

设置查询参数

Source

pub fn query_pairs( &mut self, query_pairs: impl Into<Vec<QueryPair<'r>>>, ) -> &mut Self

设置查询参数

Source

pub fn append_query_pair( &mut self, query_pair_key: impl Into<QueryPairKey<'r>>, query_pair_value: impl Into<QueryPairValue<'r>>, ) -> &mut Self

追加查询参数

Source

pub fn appended_user_agent( &mut self, user_agent: impl Into<UserAgent>, ) -> &mut Self

追加 UserAgent

Source

pub fn authorization(&mut self, authorization: Authorization<'r>) -> &mut Self

设置鉴权签名

Source

pub fn idempotent(&mut self, idempotent: Idempotent) -> &mut Self

设置为幂等请求

Source

pub fn extensions(&mut self, extensions: Extensions) -> &mut Self

设置扩展信息

Source

pub fn add_extension<T: Send + Sync + 'static>(&mut self, val: T) -> &mut Self

添加扩展信息

Source

pub fn on_uploading_progress( &mut self, callback: impl Fn(&dyn SimplifiedCallbackContext, TransferProgressInfo<'_>) -> AnyResult<()> + Send + Sync + 'r, ) -> &mut Self

设置上传进度回调函数

Source

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

设置响应状态码回调函数

Source

pub fn on_receive_response_header( &mut self, callback: impl Fn(&dyn SimplifiedCallbackContext, &HeaderName, &HeaderValue) -> AnyResult<()> + Send + Sync + 'r, ) -> &mut Self

设置响应 HTTP 头回调函数

Source

pub fn on_to_resolve_domain( &mut self, callback: impl Fn(&mut dyn CallbackContext, &str) -> AnyResult<()> + Send + Sync + 'r, ) -> &mut Self

设置域名解析前回调函数

Source

pub fn on_domain_resolved( &mut self, callback: impl Fn(&mut dyn CallbackContext, &str, &ResolveAnswers) -> AnyResult<()> + Send + Sync + 'r, ) -> &mut Self

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

Source

pub fn on_to_choose_ips( &mut self, callback: impl Fn(&mut dyn CallbackContext, &[IpAddrWithPort]) -> AnyResult<()> + Send + Sync + 'r, ) -> &mut Self

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

Source

pub fn on_ips_chosen( &mut self, callback: impl Fn(&mut dyn CallbackContext, &[IpAddrWithPort], &[IpAddrWithPort]) -> AnyResult<()> + Send + Sync + 'r, ) -> &mut Self

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

Source

pub fn on_before_request_signed( &mut self, callback: impl Fn(&mut dyn ExtendedCallbackContext) -> AnyResult<()> + Send + Sync + 'r, ) -> &mut Self

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

Source

pub fn on_after_request_signed( &mut self, callback: impl Fn(&mut dyn ExtendedCallbackContext) -> AnyResult<()> + Send + Sync + 'r, ) -> &mut Self

设置 HTTP 请求前回调函数

Source

pub fn on_response( &mut self, callback: impl Fn(&mut dyn ExtendedCallbackContext, &ResponseParts) -> AnyResult<()> + Send + Sync + 'r, ) -> &mut Self

设置响应成功回调函数

Source

pub fn on_error( &mut self, callback: impl Fn(&mut dyn ExtendedCallbackContext, &mut ResponseError) -> AnyResult<()> + Send + Sync + 'r, ) -> &mut Self

设置响应错误回调函数

Source

pub fn on_before_backoff( &mut self, callback: impl Fn(&mut dyn ExtendedCallbackContext, Duration) -> AnyResult<()> + Send + Sync + 'r, ) -> &mut Self

设置退避前回调函数

Source

pub fn on_after_backoff( &mut self, callback: impl Fn(&mut dyn ExtendedCallbackContext, Duration) -> AnyResult<()> + Send + Sync + 'r, ) -> &mut Self

设置退避后回调函数

Source

pub fn parts(&self) -> &RequestBuilderParts<'r>

获取 HTTP 请求构建器部分参数

Source

pub fn parts_mut(&mut self) -> &mut RequestBuilderParts<'r>

获取 HTTP 请求构建器部分参数的可变引用

Source

pub fn into_parts(self) -> RequestBuilderParts<'r>

转换为 HTTP 请求构建器部分参数

Source§

impl<'r, E: 'r> RequestBuilder<'r, RequestBody<'r>, E>

Source

pub fn stream_as_body( &mut self, body: impl Read + Reset + Debug + Send + Sync + 'static, content_length: u64, content_type: Option<Mime>, ) -> &mut Self

设置 HTTP 请求体为输入流

Source

pub fn referenced_stream_as_body<T: Read + Reset + Debug + Send + Sync>( &mut self, body: &'r mut T, content_length: u64, content_type: Option<Mime>, ) -> &mut Self

设置 HTTP 请求体为输入流的可变引用

Source

pub fn bytes_as_body( &mut self, body: impl Into<Vec<u8>>, content_type: Option<Mime>, ) -> &mut Self

设置 HTTP 请求体为内存数据

Source

pub fn referenced_bytes_as_body( &mut self, body: &'r [u8], content_type: Option<Mime>, ) -> &mut Self

设置 HTTP 请求体为内存数据的引用

Source

pub fn json(&mut self, body: impl Serialize) -> JsonResult<&mut Self>

设置 HTTP 请求体为 JSON 对象

Source

pub fn post_form<I, K, V>(&mut self, iter: I) -> &mut Self
where I: IntoIterator, I::Item: Borrow<(K, Option<V>)>, K: AsRef<str>, V: AsRef<str>,

设置 HTTP 请求体为表单对象

Source

pub fn multipart<'a>( &mut self, multipart: impl Into<SyncMultipart<'a>>, ) -> IoResult<&mut Self>

设置 HTTP 请求体为 Multipart 表单对象

Source§

impl<'r, E: EndpointsProvider + Clone + 'r> RequestBuilder<'r, RequestBody<'r>, E>

Source

pub fn call(&mut self) -> ApiResult<SyncResponse>

阻塞发起 HTTP 请求

Source§

impl<'r, E: 'r> RequestBuilder<'r, AsyncRequestBody<'r>, E>

Source

pub fn stream_as_body( &mut self, body: impl AsyncRead + AsyncReset + Unpin + Debug + Send + Sync + 'static, content_length: u64, content_type: Option<Mime>, ) -> &mut Self

设置 HTTP 请求体为异步输入流

Source

pub fn referenced_stream_as_body<T: AsyncRead + AsyncReset + Unpin + Debug + Send + Sync>( &mut self, body: &'r mut T, content_length: u64, content_type: Option<Mime>, ) -> &mut Self

设置 HTTP 请求体为异步输入流的可变引用

Source

pub fn bytes_as_body( &mut self, body: impl Into<Vec<u8>>, content_type: Option<Mime>, ) -> &mut Self

设置 HTTP 请求体为内存数据

Source

pub fn referenced_bytes_as_body( &mut self, body: &'r [u8], content_type: Option<Mime>, ) -> &mut Self

设置 HTTP 请求体为内存数据的引用

Source

pub fn json(&mut self, body: impl Serialize) -> JsonResult<&mut Self>

设置 HTTP 请求体为 JSON 对象

Source

pub fn post_form<I, K, V>(&mut self, iter: I) -> &mut Self
where I: IntoIterator, I::Item: Borrow<(K, Option<V>)>, K: AsRef<str>, V: AsRef<str>,

设置 HTTP 请求体为表单对象

Source

pub async fn multipart<'a>( &mut self, multipart: impl Into<AsyncMultipart<'a>>, ) -> IoResult<&mut RequestBuilder<'r, AsyncRequestBody<'r>, E>>

设置 HTTP 请求体为 Multipart 表单对象

Source§

impl<'r, E: EndpointsProvider + Clone + 'r> RequestBuilder<'r, AsyncRequestBody<'r>, E>

Source

pub async fn call(&mut self) -> ApiResult<AsyncResponse>

异步发起 HTTP 请求

Trait Implementations§

Source§

impl<'r, B: Debug + 'r, E: Debug + 'r> Debug for RequestBuilder<'r, B, E>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'r, B, E> Freeze for RequestBuilder<'r, B, E>
where E: Freeze, B: Freeze,

§

impl<'r, B, E> !RefUnwindSafe for RequestBuilder<'r, B, E>

§

impl<'r, B, E> Send for RequestBuilder<'r, B, E>
where E: Send, B: Send,

§

impl<'r, B, E> Sync for RequestBuilder<'r, B, E>
where E: Sync, B: Sync,

§

impl<'r, B, E> Unpin for RequestBuilder<'r, B, E>
where E: Unpin, B: Unpin,

§

impl<'r, B, E> !UnwindSafe for RequestBuilder<'r, B, E>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T