Struct rocket::response::status::Created [−][src]
pub struct Created<R>(_, _, _);
Expand description
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
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());
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!' }");
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
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.
Returns Ok
if a Response
could be generated successfully. Otherwise,
returns an Err
with a failing Status
. Read more
Auto Trait Implementations
impl<R> RefUnwindSafe for Created<R> where
R: RefUnwindSafe,
impl<R> UnwindSafe for Created<R> where
R: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
Converts self
into a collection.
type Output = T
type Output = T
Should always be Self
pub fn vzip(self) -> V