[−][src]Struct surf::Request
An HTTP request, returns a Response
.
Methods
impl Request<Client>
[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_types, url}; let method = http_types::Method::Get; let url = url::Url::parse("https://httpbin.org/get")?; let string = surf::Request::new(method, url).recv_string().await?;
impl<C: HttpClient> Request<C>
[src]
pub fn middleware(self, mw: impl Middleware<C>) -> Self
[src]
Push middleware onto the middleware stack.
See the middleware submodule for more information on middleware.
Examples
let res = surf::get("https://httpbin.org/get") .middleware(surf::middleware::logger::new()) .await?;
pub fn query<T: DeserializeOwned>(&self) -> Result<T, Error>
[src]
Get the URL querystring.
Examples
#[derive(Serialize, Deserialize)] struct Index { page: u32 } let req = surf::get("https://httpbin.org/get?page=2"); let Index { page } = req.query()?; assert_eq!(page, 2);
pub fn set_query(self, query: &impl Serialize + ?Sized) -> Result<Self, Error>
[src]
Set the URL querystring.
Examples
#[derive(Serialize, Deserialize)] struct Index { page: u32 } let query = Index { page: 2 }; let req = surf::get("https://httpbin.org/get").set_query(&query)?; assert_eq!(req.url().query(), Some("page=2")); assert_eq!(req.request().unwrap().url().as_str(), "https://httpbin.org/get?page=2");
pub fn header(&self, key: &HeaderName) -> Option<&Vec<HeaderValue>>
[src]
Get an HTTP header.
Examples
let req = surf::get("https://httpbin.org/get") .set_header("X-Requested-With".parse().unwrap(), "surf"); assert_eq!(req.header(&"X-Requested-With".parse().unwrap()), Some(&vec!["surf".parse().unwrap()]));
pub fn set_header(self, key: HeaderName, value: impl AsRef<str>) -> Self
[src]
Set an HTTP header.
Examples
let req = surf::get("https://httpbin.org/get") .set_header("X-Requested-With".parse().unwrap(), "surf"); assert_eq!(req.header(&"X-Requested-With".parse().unwrap()), Some(&vec!["surf".parse().unwrap()]));
pub fn method(&self) -> Method
[src]
Get the request HTTP method.
Examples
use surf::http_types; let req = surf::get("https://httpbin.org/get"); assert_eq!(req.method(), http_types::Method::Get);
pub fn url(&self) -> &Url
[src]
Get the request url.
Examples
use surf::url::Url; let req = surf::get("https://httpbin.org/get"); assert_eq!(req.url(), &Url::parse("https://httpbin.org/get")?);
pub fn mime(&self) -> Option<Mime>
[src]
Get the request MIME.
Gets the Content-Type
header and parses it to a Mime
type.
Panics
This method will panic if an invalid MIME type was set as a header. Use the set_header
method to bypass any checks.
Examples
use surf::mime; let req = surf::post("https://httpbin.org/get") .set_mime(mime::TEXT_CSS); assert_eq!(req.mime(), Some(mime::TEXT_CSS));
pub fn set_mime(self, mime: Mime) -> Self
[src]
Set the request MIME.
Examples
use surf::mime; let req = surf::post("https://httpbin.org/get") .set_mime(mime::TEXT_CSS); assert_eq!(req.mime(), Some(mime::TEXT_CSS));
pub fn body<R>(self, reader: R) -> Self where
R: BufRead + Unpin + Send + Sync + 'static,
[src]
R: BufRead + Unpin + Send + Sync + 'static,
Pass an AsyncRead
stream as the request body.
Mime
The encoding is set to application/octet-stream
.
Examples
let reader = surf::get("https://httpbin.org/get").await?; let uri = "https://httpbin.org/post"; let res = surf::post(uri).body(reader).await?; assert_eq!(res.status(), 200);
pub fn body_json(self, json: &impl Serialize + ?Sized) -> Result<Self>
[src]
Pass JSON as the request body.
Mime
The encoding is set to application/json
.
Errors
This method will return an error if the provided data could not be serialized to JSON.
Examples
let uri = "https://httpbin.org/post"; let data = serde_json::json!({ "name": "chashu" }); let res = surf::post(uri).body_json(&data)?.await?; assert_eq!(res.status(), 200);
pub fn body_string(self, string: String) -> Self
[src]
Pass a string as the request body.
Mime
The encoding is set to text/plain; charset=utf-8
.
Examples
let uri = "https://httpbin.org/post"; let data = "hello world".to_string(); let res = surf::post(uri).body_string(data).await?; assert_eq!(res.status(), 200);
pub fn body_bytes(self, bytes: impl AsRef<[u8]>) -> Self
[src]
Pass bytes as the request body.
Mime
The encoding is set to application/octet-stream
.
Examples
let uri = "https://httpbin.org/post"; let data = b"hello world"; let res = surf::post(uri).body_bytes(data).await?; assert_eq!(res.status(), 200);
pub fn body_file(self, path: impl AsRef<Path>) -> Result<Self>
[src]
Pass a file as the request body.
Mime
The encoding is set based on the file extension using mime_guess
if the operation was
successful. If path
has no extension, or its extension has no known MIME type mapping,
then None
is returned.
Errors
This method will return an error if the file couldn't be read.
Examples
let res = surf::post("https://httpbin.org/post") .body_file("README.md")? .await?; assert_eq!(res.status(), 200);
pub fn body_form(self, form: &impl Serialize + ?Sized) -> Result<Self, Error>
[src]
Pass a form as the request body.
Mime
The encoding is set to application/x-www-form-urlencoded
.
Errors
An error will be returned if the encoding failed.
Examples
#[derive(Serialize, Deserialize)] struct Body { apples: u32 } let res = surf::post("https://httpbin.org/post") .body_form(&Body { apples: 7 })? .await?; assert_eq!(res.status(), 200);
pub async fn recv_bytes(self) -> Result<Vec<u8>, Error>
[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, Error>
[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, Error>
[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, Error>
[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 request(&self) -> Option<&Request>
[src]
Get a HTTP request
Trait Implementations
impl<C: HttpClient> Debug for Request<C>
[src]
impl<C: HttpClient> Future for Request<C>
[src]
type Output = Result<Response, Error>
The type of value produced on completion.
fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Self::Output>
[src]
impl<C: HttpClient> Into<Request> for Request<C>
[src]
impl IntoIterator for Request<Client>
[src]
type Item = (HeaderName, Vec<HeaderValue>)
The type of the elements being iterated over.
type IntoIter = IntoIter
Which kind of iterator are we turning this into?
fn into_iter(self) -> Self::IntoIter
[src]
Returns a iterator of references over the remaining items.
impl<'a> IntoIterator for &'a Request<Client>
[src]
type Item = (&'a HeaderName, &'a Vec<HeaderValue>)
The type of the elements being iterated over.
type IntoIter = Iter<'a>
Which kind of iterator are we turning this into?
fn into_iter(self) -> Self::IntoIter
[src]
impl<'a> IntoIterator for &'a mut Request<Client>
[src]
type Item = (&'a HeaderName, &'a mut Vec<HeaderValue>)
The type of the elements being iterated over.
type IntoIter = IterMut<'a>
Which kind of iterator are we turning this into?
fn into_iter(self) -> Self::IntoIter
[src]
impl TryFrom<Request> for Request<Client>
[src]
Auto Trait Implementations
impl<C> !RefUnwindSafe for Request<C>
impl<C> Send for Request<C>
impl<C> !Sync for Request<C>
impl<C> Unpin for Request<C>
impl<C> !UnwindSafe for Request<C>
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,
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,
fn delay(self, dur: Duration) -> DelayFuture<Self>
[src]
fn flatten(self) -> FlattenFuture<Self, <Self::Output as IntoFuture>::Future> where
Self::Output: IntoFuture,
[src]
Self::Output: IntoFuture,
fn race<F>(self, other: F) -> Race<Self, F> where
F: Future<Output = Self::Output>,
Self: Future,
[src]
F: Future<Output = Self::Output>,
Self: Future,
fn try_race<F, T, E>(self, other: F) -> TryRace<Self, F> where
F: Future<Output = Self::Output>,
Self: Future<Output = Result<T, E>>,
[src]
F: Future<Output = Self::Output>,
Self: Future<Output = Result<T, E>>,
fn join<F>(self, other: F) -> Join<Self, F> where
F: Future,
Self: Future,
[src]
F: Future,
Self: Future,
fn try_join<F, A, B, E>(self, other: F) -> TryJoin<Self, F> where
F: Future<Output = Result<B, E>>,
Self: Future<Output = Result<A, E>>,
[src]
F: Future<Output = Result<B, E>>,
Self: Future<Output = Result<A, E>>,
fn timeout(self, dur: Duration) -> TimeoutFuture<Self>
[src]
impl<T> FutureExt for T where
T: Future + ?Sized,
[src]
T: Future + ?Sized,
fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Output) -> U,
[src]
F: FnOnce(Self::Output) -> U,
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,
fn left_future<B>(self) -> Either<Self, B> where
B: Future<Output = Self::Output>,
[src]
B: Future<Output = Self::Output>,
fn right_future<A>(self) -> Either<A, Self> where
A: Future<Output = Self::Output>,
[src]
A: Future<Output = Self::Output>,
fn into_stream(self) -> IntoStream<Self>
[src]
fn flatten(self) -> Flatten<Self> where
Self::Output: Future,
[src]
Self::Output: Future,
fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,
[src]
Self::Output: Stream,
fn fuse(self) -> Fuse<Self>
[src]
fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Output),
[src]
F: FnOnce(&Self::Output),
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,
[src]
Self: UnwindSafe,
fn shared(self) -> Shared<Self> where
Self::Output: Clone,
[src]
Self::Output: Clone,
fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)
[src]
fn boxed<'a>(self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send>> where
Self: Send + 'a,
[src]
Self: Send + 'a,
fn boxed_local<'a>(self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a>> where
Self: 'a,
[src]
Self: 'a,
fn unit_error(self) -> UnitError<Self>
[src]
fn never_error(self) -> NeverError<Self>
[src]
fn poll_unpin(&mut self, cx: &mut Context) -> Poll<Self::Output> where
Self: Unpin,
[src]
Self: Unpin,
fn now_or_never(self) -> Option<Self::Output>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
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?
fn into_future(self) -> <T as IntoFuture>::Future
[src]
impl<I> IntoIterator for I where
I: Iterator,
[src]
I: Iterator,
type Item = <I as Iterator>::Item
The type of the elements being iterated over.
type IntoIter = I
Which kind of iterator are we turning this into?
fn into_iter(self) -> I
[src]
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.
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,
[src]
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
fn try_poll(self: Pin<&mut F>, cx: &mut Context) -> Poll<<F as Future>::Output>
[src]
impl<Fut> TryFutureExt for Fut where
Fut: TryFuture + ?Sized,
[src]
Fut: TryFuture + ?Sized,
fn flatten_sink<Item>(self) -> FlattenSink<Self, Self::Ok> where
Self::Ok: Sink<Item>,
<Self::Ok as Sink<Item>>::Error == Self::Error,
[src]
Self::Ok: Sink<Item>,
<Self::Ok as Sink<Item>>::Error == Self::Error,
fn map_ok<T, F>(self, f: F) -> MapOk<Self, F> where
F: FnOnce(Self::Ok) -> T,
[src]
F: FnOnce(Self::Ok) -> T,
fn map_ok_or_else<T, E, F>(self, e: E, f: F) -> MapOkOrElse<Self, F, E> where
E: FnOnce(Self::Error) -> T,
F: FnOnce(Self::Ok) -> T,
[src]
E: FnOnce(Self::Error) -> T,
F: FnOnce(Self::Ok) -> T,
fn map_err<E, F>(self, f: F) -> MapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
[src]
F: FnOnce(Self::Error) -> E,
fn err_into<E>(self) -> ErrInto<Self, E> where
Self::Error: Into<E>,
[src]
Self::Error: Into<E>,
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>,
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>,
fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F> where
F: FnOnce(&Self::Ok),
[src]
F: FnOnce(&Self::Ok),
fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
F: FnOnce(&Self::Error),
[src]
F: FnOnce(&Self::Error),
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,
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,
fn compat(self) -> Compat<Self> where
Self: Unpin,
[src]
Self: Unpin,
fn into_future(self) -> IntoFuture<Self>
[src]
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>,