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

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

Returns the HTTP status of self.

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

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

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();

Returns the HTTP headers of self.

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

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

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();

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

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

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

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();

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();
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>();
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

Attempts to read from the AsyncRead into buf. Read more

Formats the value using the given formatter. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Creates a new AsyncRead instance that chains this stream with next. Read more

Pulls some bytes from this source into the specified buffer, returning how many bytes were read. Read more

Pulls some bytes from this source into the specified buffer, advancing the buffer’s internal cursor. Read more

Reads the exact number of bytes required to fill buf. Read more

Reads an unsigned 8 bit integer from the underlying reader. Read more

Reads a signed 8 bit integer from the underlying reader. Read more

Reads an unsigned 16-bit integer in big-endian order from the underlying reader. Read more

Reads a signed 16-bit integer in big-endian order from the underlying reader. Read more

Reads an unsigned 32-bit integer in big-endian order from the underlying reader. Read more

Reads a signed 32-bit integer in big-endian order from the underlying reader. Read more

Reads an unsigned 64-bit integer in big-endian order from the underlying reader. Read more

Reads an signed 64-bit integer in big-endian order from the underlying reader. Read more

Reads an unsigned 128-bit integer in big-endian order from the underlying reader. Read more

Reads an signed 128-bit integer in big-endian order from the underlying reader. Read more

Reads an 32-bit floating point type in big-endian order from the underlying reader. Read more

Reads an 64-bit floating point type in big-endian order from the underlying reader. Read more

Reads an unsigned 16-bit integer in little-endian order from the underlying reader. Read more

Reads a signed 16-bit integer in little-endian order from the underlying reader. Read more

Reads an unsigned 32-bit integer in little-endian order from the underlying reader. Read more

Reads a signed 32-bit integer in little-endian order from the underlying reader. Read more

Reads an unsigned 64-bit integer in little-endian order from the underlying reader. Read more

Reads an signed 64-bit integer in little-endian order from the underlying reader. Read more

Reads an unsigned 128-bit integer in little-endian order from the underlying reader. Read more

Reads an signed 128-bit integer in little-endian order from the underlying reader. Read more

Reads an 32-bit floating point type in little-endian order from the underlying reader. Read more

Reads an 64-bit floating point type in little-endian order from the underlying reader. Read more

Reads all bytes until EOF in this source, placing them into buf. Read more

Reads all bytes until EOF in this source, appending them to buf. Read more

Creates an adaptor which reads at most limit bytes from it. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

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

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

Calls U::from(self).

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

Converts self into a collection.

Should always be Self

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

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

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