Struct rocket::local::asynchronous::LocalResponse

pub struct LocalResponse<'c> { /* private fields */ }

An async response from a dispatched LocalRequest.

This LocalResponse implements tokio::io::AsyncRead. As such, if into_string() and into_bytes() do not suffice, the response’s body can be read directly:

use std::io;

use rocket::local::asynchronous::Client;
use rocket::tokio::io::AsyncReadExt;
use rocket::http::Status;

#[get("/")]
fn hello_world() -> &'static str {
    "Hello, world!"
}

#[launch]
fn rocket() -> _ {
    rocket::build().mount("/", routes![hello_world])
}

// Dispatch a `GET /` request.
let client = Client::tracked(rocket()).await.expect("valid rocket");
let mut response = client.get("/").dispatch().await;

// Check metadata validity.
assert_eq!(response.status(), Status::Ok);
assert_eq!(response.body().preset_size(), Some(13));

// Read 10 bytes of the body. Note: in reality, we'd use `into_string()`.
let mut buffer = [0; 10];
response.read(&mut buffer).await?;
assert_eq!(buffer, "Hello, wor".as_bytes());

For more, see the top-level documentation.

Implementations

impl LocalResponse<'_>

pub fn status(&self) -> Status

Returns the HTTP status of self.

Example

use rocket::local::asynchronous::LocalResponse;

let response: LocalResponse = response;
let status = response.status();

pub fn content_type(&self) -> Option<ContentType>

Returns the Content-Type, if a valid one is set, of self.

Example

use rocket::local::asynchronous::LocalResponse;

let response: LocalResponse = response;
let content_type = response.content_type();

pub fn headers(&self) -> &HeaderMap<'_>

Returns the HTTP headers of self.

Example

use rocket::local::asynchronous::LocalResponse;

let response: LocalResponse = response;
let headers = response.headers();

pub fn cookies(&self) -> &CookieJar<'_>

Return a cookie jar containing the HTTP cookies in the response.

Example

use rocket::local::asynchronous::LocalResponse;

let response: LocalResponse = response;
let string = response.cookies();

pub fn body(&self) -> &Body<'_>

Returns the response body, if there is one, of self.

Example

use rocket::local::asynchronous::LocalResponse;

let response: LocalResponse = response;
let body = response.body();

pub async fn into_string(self) -> Option<String>

Consumes self and reads the entirety of its body into a string.

If reading fails, the body contains invalid UTF-8 characters, or the body is unset in the response, returns None. Otherwise, returns Some. The string may be empty if the body is empty.

Example

use rocket::local::asynchronous::LocalResponse;

let response: LocalResponse = response;
let string = response.into_string();

pub async fn into_bytes(self) -> Option<Vec<u8>>

Consumes self and reads the entirety of its body into a Vec of bytes.

If reading fails or the body is unset in the response, returns None. Otherwise, returns Some. The returned vector may be empty if the body is empty.

Example

use rocket::local::asynchronous::LocalResponse;

let response: LocalResponse = response;
let bytes = response.into_bytes();

pub async fn into_json<T>(self) -> Option<T>

where T: Send + DeserializeOwned + 'static,

Available on crate feature json only.

Consumes self and deserializes its body as JSON without buffering in memory.

If deserialization fails or the body is unset in the response, returns None. Otherwise, returns Some.

Example

use rocket::local::asynchronous::LocalResponse;
use rocket::serde::Deserialize;

#[derive(Deserialize)]
struct Task {
    id: usize,
    complete: bool,
    text: String,
}

let response: LocalResponse = response;
let task = response.into_json::<Task>();

pub async fn into_msgpack<T>(self) -> Option<T>

where T: Send + DeserializeOwned + 'static,

Available on crate feature msgpack only.

Consumes self and deserializes its body as MessagePack without buffering in memory.

If deserialization fails or the body is unset in the response, returns None. Otherwise, returns Some.

Example

use rocket::local::asynchronous::LocalResponse;
use rocket::serde::Deserialize;

#[derive(Deserialize)]
struct Task {
    id: usize,
    complete: bool,
    text: String,
}

let response: LocalResponse = response;
let task = response.into_msgpack::<Task>();

Trait Implementations

impl AsyncRead for LocalResponse<'_>

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll<Result<()>>

Attempts to read from the AsyncRead into buf.

impl Debug for LocalResponse<'_>

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

Formats the value using the given formatter.

impl Drop for LocalResponse<'_>

fn drop(&mut self)

Executes the destructor for this type.