Struct jet::client::Response
[−]
[src]
pub struct Response { /* fields omitted */ }
A Response to a submitted Request
.
Methods
impl Response
[src]
pub fn url(&self) -> &Url
[src]
Get the final Url
of this Response
.
Example
let resp = reqwest::get("http://httpbin.org/redirect/1")?; assert_eq!(resp.url().as_str(), "http://httpbin.org/get");
pub fn status(&self) -> StatusCode
[src]
Get the StatusCode
of this Response
.
Examples
let resp = reqwest::get("http://httpbin.org/get")?; if resp.status().is_success() { println!("success!"); } else if resp.status().is_server_error() { println!("server error!"); } else { println!("Something else happened. Status: {:?}", resp.status()); }
use reqwest::Client; use reqwest::StatusCode; let client = Client::new(); let resp = client.post("http://httpbin.org/post") .body("possibly too large") .send()?; match resp.status() { StatusCode::Ok => println!("success!"), StatusCode::PayloadTooLarge => { println!("Request payload is too large!"); } s => println!("Received response status: {:?}", s), };
pub fn headers(&self) -> &Headers
[src]
Get the Headers
of this Response
.
Example
Checking the Content-Length
header before reading the response body.
let client = Client::new(); let mut resp = client.head("http://httpbin.org/bytes/3000").send()?; if resp.status().is_success() { let len = resp.headers().get::<ContentLength>() .map(|ct_len| **ct_len) .unwrap_or(0); // limit 1mb response if len <= 1_000_000 { let mut buf = Vec::with_capacity(len as usize); let mut resp = reqwest::get("http://httpbin.org/bytes/3000")?; if resp.status().is_success() { ::std::io::copy(&mut resp, &mut buf)?; } } }
pub fn json<T>(&mut self) -> Result<T, Error> where
T: DeserializeOwned,
[src]
T: DeserializeOwned,
Try and deserialize the response body as JSON using serde
.
Examples
#[derive(Deserialize)] struct Ip { origin: String, } let json: Ip = reqwest::get("http://httpbin.org/ip")?.json()?;
Errors
This method fails whenever the response body is not in JSON format
or it cannot be properly deserialized to target type T
. For more
details please see [serde_json::from_reader
].
[serde_json::from_reader
]: https://docs.serde.rs/serde_json/fn.from_reader.html
pub fn text(&mut self) -> Result<String, Error>
[src]
Get the response text.
This method decodes the response body with BOM sniffing
and with malformed sequences replaced with the REPLACEMENT CHARACTER.
Encoding is determinated from the charset
parameter of Content-Type
header,
and defaults to utf-8
if not presented.
Example
let content = reqwest::get("http://httpbin.org/range/26")?.text()?;
pub fn copy_to<W>(&mut self, w: &mut W) -> Result<u64, Error> where
W: Write + ?Sized,
[src]
W: Write + ?Sized,
Copy the response body into a writer.
This function internally uses [std::io::copy
] and hence will continuously read data from
the body and then write it into writer in a streaming fashion until EOF is met.
On success, the total number of bytes that were copied to writer
is returned.
[std::io::copy
]: https://doc.rust-lang.org/std/io/fn.copy.html
Example
let mut resp = reqwest::get("http://httpbin.org/range/5")?; let mut buf: Vec<u8> = vec![]; resp.copy_to(&mut buf)?; assert_eq!(b"abcde", buf.as_slice());
pub fn error_for_status(self) -> Result<Response, Error>
[src]
Turn a response into an error if the server returned an error.
Example
let res = reqwest::get("http://httpbin.org/status/400")? .error_for_status(); if let Err(err) = res { assert_eq!(err.status(), Some(reqwest::StatusCode::BadRequest)); }
Trait Implementations
impl Read for Response
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>
[src]
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
unsafe fn initializer(&self) -> Initializer
[src]
read_initializer
)Determines if this Read
er can work with buffers of uninitialized memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0[src]
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
Read all bytes until EOF in this source, appending them to buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
Read the exact number of bytes required to fill buf
. Read more
ⓘImportant traits for &'a mut Wfn by_ref(&mut self) -> &mut Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Read
. Read more
ⓘImportant traits for Bytes<R>fn bytes(self) -> Bytes<Self>
1.0.0[src]
Transforms this Read
instance to an [Iterator
] over its bytes. Read more
ⓘImportant traits for Chars<R>fn chars(self) -> Chars<Self>
[src]
🔬 This is a nightly-only experimental API. (io
)
the semantics of a partial read/write of where errors happen is currently unclear and may change
Transforms this Read
instance to an [Iterator
] over [char
]s. Read more
ⓘImportant traits for Chain<T, U>fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
R: Read,
Creates an adaptor which will chain this stream with another. Read more
ⓘImportant traits for Take<T>fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
Creates an adaptor which will read at most limit
bytes from it. Read more