Struct surf::RequestBuilder [−][src]
Request Builder
Provides an ergonomic way to chain the creation of a request.
This is generally accessed as the return value from surf::{method}(),
however Request::builder is also provided.
Examples
use surf::http::{Method, mime::HTML, Url}; let mut request = surf::post("https://httpbin.org/post") .body("<html>hi</html>") .header("custom-header", "value") .content_type(HTML) .build(); assert_eq!(request.take_body().into_string().await.unwrap(), "<html>hi</html>"); assert_eq!(request.method(), Method::Post); assert_eq!(request.url(), &Url::parse("https://httpbin.org/post")?); assert_eq!(request["custom-header"], "value"); assert_eq!(request["content-type"], "text/html;charset=utf-8");
use surf::http::{Method, Url}; let url = Url::parse("https://httpbin.org/post")?; let request = surf::Request::builder(Method::Post, url).build();
Implementations
impl RequestBuilder[src]
pub fn new(method: Method, url: Url) -> Self[src]
Create a new instance.
This method is particularly useful when input URLs might be passed by third parties, and you don’t want to panic if they’re malformed. If URLs are statically encoded, it might be easier to use one of the shorthand methods instead.
Examples
use surf::http::{Method, Url}; let url = Url::parse("https://httpbin.org/get")?; let req = surf::RequestBuilder::new(Method::Get, url).build();
pub fn header(
self,
key: impl Into<HeaderName>,
value: impl ToHeaderValues
) -> Self[src]
self,
key: impl Into<HeaderName>,
value: impl ToHeaderValues
) -> Self
Sets a header on the request.
Examples
let req = surf::get("https://httpbin.org/get").header("header-name", "header-value").build(); assert_eq!(req["header-name"], "header-value");
pub fn content_type(self, content_type: impl Into<Mime>) -> Self[src]
Sets the Content-Type header on the request.
Examples
let req = surf::post("https://httpbin.org/post").content_type(mime::HTML).build(); assert_eq!(req["content-type"], "text/html;charset=utf-8");
pub fn body(self, body: impl Into<Body>) -> Self[src]
Sets the body of the request.
Examples
use serde_json::json; let mut req = surf::post("https://httpbin.org/post").body(json!({ "any": "Into<Body>"})).build(); assert_eq!(req.take_body().into_string().await.unwrap(), "{\"any\":\"Into<Body>\"}");
pub fn query(self, query: &impl Serialize) -> Result<Self, Error>[src]
Set the URL querystring.
Examples
#[derive(Serialize, Deserialize)] struct Index { page: u32 } let query = Index { page: 2 }; let mut req = surf::get("https://httpbin.org/get").query(&query)?.build(); assert_eq!(req.url().query(), Some("page=2")); assert_eq!(req.url().as_str(), "https://httpbin.org/get?page=2");
pub async fn recv_bytes(self) -> Result<Vec<u8>>[src]
Submit the request and get the response body as bytes.
Examples
let bytes = surf::get("https://httpbin.org/get").recv_bytes().await?; assert!(bytes.len() > 0);
pub async fn recv_string(self) -> Result<String>[src]
Submit the request and get the response body as a string.
Examples
let string = surf::get("https://httpbin.org/get").recv_string().await?; assert!(string.len() > 0);
pub async fn recv_json<T: DeserializeOwned>(self) -> Result<T>[src]
Submit the request and decode the response body from json into a struct.
Examples
#[derive(Deserialize, Serialize)] struct Ip { ip: String } let uri = "https://api.ipify.org?format=json"; let Ip { ip } = surf::get(uri).recv_json().await?; assert!(ip.len() > 10);
pub async fn recv_form<T: DeserializeOwned>(self) -> Result<T>[src]
Submit the request and decode the response body from form encoding into a struct.
Errors
Any I/O error encountered while reading the body is immediately returned
as an Err.
If the body cannot be interpreted as valid json for the target type T,
an Err is returned.
Examples
#[derive(Deserialize, Serialize)] struct Body { apples: u32 } let url = "https://api.example.com/v1/response"; let Body { apples } = surf::get(url).recv_form().await?;
pub fn middleware(self, middleware: impl Middleware) -> Self[src]
Push middleware onto a per-request middleware stack.
Important: Setting per-request middleware incurs extra allocations.
Creating a Client with middleware is recommended.
Client middleware is run before per-request middleware.
See the middleware submodule for more information on middleware.
Examples
let res = surf::get("https://httpbin.org/get") .middleware(surf::middleware::Redirect::default()) .await?;
pub fn build(self) -> Request[src]
Return the constructed Request.
pub async fn send(self) -> Result<Response>[src]
Create a Client and send the constructed Request from it.
Trait Implementations
impl Debug for RequestBuilder[src]
impl From<RequestBuilder> for Request[src]
fn from(builder: RequestBuilder) -> Request[src]
Converts a surf::RequestBuilder to a surf::Request.
impl Future for RequestBuilder[src]
Auto Trait Implementations
impl !RefUnwindSafe for RequestBuilder
impl Send for RequestBuilder
impl !Sync for RequestBuilder
impl Unpin for RequestBuilder
impl !UnwindSafe for RequestBuilder
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T[src]
impl<T> From<T> for T[src]
impl<T> FutureExt for T where
T: Future + ?Sized, [src]
T: Future + ?Sized,
pub fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Output) -> U, [src]
F: FnOnce(Self::Output) -> U,
pub fn map_into<U>(self) -> MapInto<Self, U> where
Self::Output: Into<U>, [src]
Self::Output: Into<U>,
pub fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
F: FnOnce(Self::Output) -> Fut,
Fut: Future, [src]
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
pub fn left_future<B>(self) -> Either<Self, B> where
B: Future<Output = Self::Output>, [src]
B: Future<Output = Self::Output>,
pub fn right_future<A>(self) -> Either<A, Self> where
A: Future<Output = Self::Output>, [src]
A: Future<Output = Self::Output>,
pub fn into_stream(self) -> IntoStream<Self>[src]
pub fn flatten(self) -> Flatten<Self> where
Self::Output: Future, [src]
Self::Output: Future,
pub fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream, [src]
Self::Output: Stream,
pub fn fuse(self) -> Fuse<Self>[src]
pub fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Output), [src]
F: FnOnce(&Self::Output),
pub fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe, [src]
Self: UnwindSafe,
pub fn shared(self) -> Shared<Self> where
Self::Output: Clone, [src]
Self::Output: Clone,
pub fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>> where
Self: Send + 'a, [src]
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>> where
Self: Send + 'a,
pub fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a, [src]
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,
pub fn unit_error(self) -> UnitError<Self>[src]
pub fn never_error(self) -> NeverError<Self>[src]
pub fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin, [src]
Self: Unpin,
pub fn now_or_never(self) -> Option<Self::Output>[src]
impl<T> FutureExt for T where
T: Future + ?Sized, [src]
T: Future + ?Sized,
pub fn delay(self, dur: Duration) -> DelayFuture<Self>[src]
pub fn flatten(
self
) -> FlattenFuture<Self, <Self::Output as IntoFuture>::Future> where
Self::Output: IntoFuture, [src]
self
) -> FlattenFuture<Self, <Self::Output as IntoFuture>::Future> where
Self::Output: IntoFuture,
pub fn race<F>(self, other: F) -> Race<Self, F> where
Self: Future,
F: Future<Output = Self::Output>, [src]
Self: Future,
F: Future<Output = Self::Output>,
pub fn try_race<F, T, E>(self, other: F) -> TryRace<Self, F> where
Self: Future<Output = Result<T, E>>,
F: Future<Output = Self::Output>, [src]
Self: Future<Output = Result<T, E>>,
F: Future<Output = Self::Output>,
pub fn join<F>(self, other: F) -> Join<Self, F> where
Self: Future,
F: Future, [src]
Self: Future,
F: Future,
pub fn try_join<F, A, B, E>(self, other: F) -> TryJoin<Self, F> where
Self: Future<Output = Result<A, E>>,
F: Future<Output = Result<B, E>>, [src]
Self: Future<Output = Result<A, E>>,
F: Future<Output = Result<B, E>>,
pub fn timeout(self, dur: Duration) -> TimeoutFuture<Self>[src]
impl<F> FutureExt for F where
F: Future + ?Sized,
F: Future + ?Sized,
pub fn or<F>(self, other: F) -> Or<Self, F> where
F: Future<Output = Self::Output>,
F: Future<Output = Self::Output>,
pub fn race<F>(self, other: F) -> Race<Self, F> where
F: Future<Output = Self::Output>,
F: Future<Output = Self::Output>,
pub fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,
Self: UnwindSafe,
pub fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>> where
Self: Send + 'a,
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>> where
Self: Send + 'a,
pub fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,
impl<T> Instrument for T[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>[src]
pub fn in_current_span(self) -> Instrumented<Self>[src]
impl<T> Instrument for T[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>[src]
pub fn in_current_span(self) -> Instrumented<Self>[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<F> IntoFuture for F where
F: Future, [src]
F: Future,
type Output = <F as Future>::Output
🔬 This is a nightly-only experimental API. (
into_future)The output that the future will produce on completion.
type Future = F
🔬 This is a nightly-only experimental API. (
into_future)Which kind of future are we turning this into?
pub fn into_future(self) -> <F as IntoFuture>::Future[src]
impl<T> IntoFuture for T where
T: Future, [src]
T: Future,
type Output = <T as Future>::Output
The type of value produced on completion.
type Future = T
Which kind of future are we turning this into?
pub fn into_future(self) -> <T as IntoFuture>::Future[src]
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<F, T, E> TryFuture for F where
F: Future<Output = Result<T, E>> + ?Sized,
F: Future<Output = Result<T, E>> + ?Sized,
type Ok = T
The type of successful values yielded by this future
type Error = E
The type of failures yielded by this future
pub fn try_poll(
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>
impl<Fut> TryFutureExt for Fut where
Fut: TryFuture + ?Sized, [src]
Fut: TryFuture + ?Sized,
pub fn map_ok<T, F>(self, f: F) -> MapOk<Self, F> where
F: FnOnce(Self::Ok) -> T, [src]
F: FnOnce(Self::Ok) -> T,
pub fn map_ok_or_else<T, E, F>(self, e: E, f: F) -> MapOkOrElse<Self, F, E> where
F: FnOnce(Self::Ok) -> T,
E: FnOnce(Self::Error) -> T, [src]
F: FnOnce(Self::Ok) -> T,
E: FnOnce(Self::Error) -> T,
pub fn map_err<E, F>(self, f: F) -> MapErr<Self, F> where
F: FnOnce(Self::Error) -> E, [src]
F: FnOnce(Self::Error) -> E,
pub fn err_into<E>(self) -> ErrInto<Self, E> where
Self::Error: Into<E>, [src]
Self::Error: Into<E>,
pub fn ok_into<U>(self) -> OkInto<Self, U> where
Self::Ok: Into<U>, [src]
Self::Ok: Into<U>,
pub fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F> where
F: FnOnce(Self::Ok) -> Fut,
Fut: TryFuture<Error = Self::Error>, [src]
F: FnOnce(Self::Ok) -> Fut,
Fut: TryFuture<Error = Self::Error>,
pub fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F> where
F: FnOnce(Self::Error) -> Fut,
Fut: TryFuture<Ok = Self::Ok>, [src]
F: FnOnce(Self::Error) -> Fut,
Fut: TryFuture<Ok = Self::Ok>,
pub fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F> where
F: FnOnce(&Self::Ok), [src]
F: FnOnce(&Self::Ok),
pub fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
F: FnOnce(&Self::Error), [src]
F: FnOnce(&Self::Error),
pub fn try_flatten(self) -> TryFlatten<Self, Self::Ok> where
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error, [src]
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,
pub fn try_flatten_stream(self) -> TryFlattenStream<Self> where
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error == Self::Error, [src]
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error == Self::Error,
pub fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F> where
F: FnOnce(Self::Error) -> Self::Ok, [src]
F: FnOnce(Self::Error) -> Self::Ok,
pub fn into_future(self) -> IntoFuture<Self>[src]
pub fn try_poll_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<Self::Ok, Self::Error>> where
Self: Unpin, [src]
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<Self::Ok, Self::Error>> where
Self: Unpin,
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,
pub fn vzip(self) -> V
impl<T> WithSubscriber for T[src]
pub fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>, [src]
S: Into<Dispatch>,