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
sourceimpl<'r, R> Created<R>
impl<'r, R> Created<R>
sourcepub fn new<L: Into<Cow<'static, str>>>(location: L) -> Self
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());
sourcepub fn body(self, responder: R) -> Self
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!' }");
sourcepub fn tagged_body(self, responder: R) -> Self where
R: Hash,
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
sourceimpl<'r, 'o: 'r, R: Responder<'r, 'o>> Responder<'r, 'o> for Created<R>
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.
sourcefn respond_to(self, req: &'r Request<'_>) -> Result<'o>
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
. Read more
impl<R> StructuralPartialEq for Created<R>
Auto Trait Implementations
impl<R> RefUnwindSafe for Created<R> where
R: RefUnwindSafe,
impl<R> Send for Created<R> where
R: Send,
impl<R> Sync for Created<R> where
R: Sync,
impl<R> Unpin for Created<R> where
R: Unpin,
impl<R> UnwindSafe for Created<R> where
R: UnwindSafe,
Blanket Implementations
impl<'a, T> AsTaggedExplicit<'a> for T where
T: 'a,
impl<'a, T> AsTaggedExplicit<'a> for T where
T: 'a,
fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self>
impl<'a, T> AsTaggedImplicit<'a> for T where
T: 'a,
impl<'a, T> AsTaggedImplicit<'a> for T where
T: 'a,
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> IntoCollection<T> for T
impl<T> IntoCollection<T> for T
sourcefn into_collection<A>(self) -> SmallVec<A> where
A: Array<Item = T>,
fn into_collection<A>(self) -> SmallVec<A> where
A: Array<Item = T>,
Converts self
into a collection.
fn mapped<U, F, A>(self, f: F) -> SmallVec<A> where
F: FnMut(T) -> U,
A: Array<Item = U>,
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more