Struct rocketjson_data::api::response::ApiResponse
source · [−]pub struct ApiResponse<T> {
pub json: Json<T>,
pub status: Status,
}
Expand description
Is returned by enpoints to achieve a Json Response
Requirements
T has to implement serde::Serialize
Example
- Code
#[derive(serde::Serialize)]
pub struct TestResponse {
data: String
}
#[post("/test")]
pub fn test() -> rocketjson::ApiResponse<TestResponse> {
rocketjson::ApiResponse::new(
rocket::http::Status::Ok,
TestResponse { data: String::from("test") }
)
}
- Response (200 OK)
{
data: "test"
}
Fields
json: Json<T>
This is the Json-data sent to the client
status: Status
This is the Statuscode sent to the client, it is not included in the Json
Implementations
sourceimpl<T> ApiResponse<T>
impl<T> ApiResponse<T>
Trait Implementations
sourceimpl<T: Debug> Debug for ApiResponse<T>
impl<T: Debug> Debug for ApiResponse<T>
sourceimpl<'r, T> Responder<'r, 'static> for ApiResponse<T> where
T: Serialize,
impl<'r, T> Responder<'r, 'static> for ApiResponse<T> where
T: Serialize,
sourcefn respond_to(self, req: &'r Request<'_>) -> Result<'static>
fn respond_to(self, req: &'r Request<'_>) -> Result<'static>
Returns Ok
if a Response
could be generated successfully. Otherwise,
returns an Err
with a failing Status
. Read more
Auto Trait Implementations
impl<T> RefUnwindSafe for ApiResponse<T> where
T: RefUnwindSafe,
impl<T> Send for ApiResponse<T> where
T: Send,
impl<T> Sync for ApiResponse<T> where
T: Sync,
impl<T> Unpin for ApiResponse<T> where
T: Unpin,
impl<T> UnwindSafe for ApiResponse<T> where
T: UnwindSafe,
Blanket Implementations
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>
impl<T> IntoCollection<T> for T
impl<T> IntoCollection<T> for T
fn 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>,
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