Struct rocket::response::status::Created

pub struct Created<R>(/* private fields */);

Sets the status of the response to 201 Created.

Sets the Location header and optionally the ETag header in the response. The body of the response, which identifies the created resource, can be set via the builder methods Created::body() and Created::tagged_body(). While both builder methods set the responder, the Created::tagged_body() additionally computes a hash for the responder which is used as the value of the ETag header when responding.

Example

use rocket::response::status;

let response = status::Created::new("http://myservice.com/resource.json")
    .tagged_body("{ 'resource': 'Hello, world!' }");

Implementations

impl<R> Created<R>

pub fn new<L: Into<Cow<'static, str>>>(location: L) -> Self

Constructs a Created response with a location and no body.

Example

use rocket::response::status;

#[get("/")]
fn create() -> status::Created<&'static str> {
    status::Created::new("http://myservice.com/resource.json")
}

let response = client.get("/").dispatch();

let loc = response.headers().get_one("Location");
assert_eq!(loc, Some("http://myservice.com/resource.json"));
assert!(response.body().is_none());

pub fn body(self, responder: R) -> Self

Adds responder as the body of self.

Unlike tagged_body(), this method does not result in an ETag header being set in the response.

Example

use rocket::response::status;

#[get("/")]
fn create() -> status::Created<&'static str> {
    status::Created::new("http://myservice.com/resource.json")
        .body("{ 'resource': 'Hello, world!' }")
}

let response = client.get("/").dispatch();

let loc = response.headers().get_one("Location");
assert_eq!(loc, Some("http://myservice.com/resource.json"));

let etag = response.headers().get_one("ETag");
assert_eq!(etag, None);

let body = response.into_string();
assert_eq!(body.unwrap(), "{ 'resource': 'Hello, world!' }");

pub fn tagged_body(self, responder: R) -> Self

where R: Hash,

Adds responder as the body of self. Computes a hash of the responder to be used as the value of the ETag header.

Example

use rocket::response::status;

#[get("/")]
fn create() -> status::Created<&'static str> {
    status::Created::new("http://myservice.com/resource.json")
        .tagged_body("{ 'resource': 'Hello, world!' }")
}

let response = client.get("/").dispatch();

let loc = response.headers().get_one("Location");
assert_eq!(loc, Some("http://myservice.com/resource.json"));

let etag = response.headers().get_one("ETag");
assert_eq!(etag, Some(r#""13046220615156895040""#));

let body = response.into_string();
assert_eq!(body.unwrap(), "{ 'resource': 'Hello, world!' }");

Trait Implementations

impl<R: Clone> Clone for Created<R>

fn clone(&self) -> Created<R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<R: Debug> Debug for Created<R>

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

Formats the value using the given formatter.

impl<R: PartialEq> PartialEq for Created<R>

fn eq(&self, other: &Created<R>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'r, 'o: 'r, R: Responder<'r, 'o>> Responder<'r, 'o> for Created<R>

Sets the status code of the response to 201 Created. Sets the Location header to the parameter in the Created::new() constructor.

The optional responder, set via Created::body() or Created::tagged_body() finalizes the response if it exists. The wrapped responder should write the body of the response so that it contains information about the created resource. If no responder is provided, the response body will be empty.

In addition to setting the status code, Location header, and finalizing the response with the Responder, the ETag header is set conditionally if a hashable Responder is provided via Created::tagged_body(). The ETag header is set to a hash value of the responder.

fn respond_to(self, req: &'r Request<'_>) -> Result<'o>

Returns Ok if a Response could be generated successfully. Otherwise, returns an Err with a failing Status.

impl<R> StructuralPartialEq for Created<R>