Struct rocketjson_data::api::response::ApiResponse

pub struct ApiResponse<T> {
    pub json: Json<T>,
    pub status: Status,
}

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

impl<T> ApiResponse<T>

pub fn new(status: Status, json_data: T) -> Self

Trait Implementations

impl<T: Debug> Debug for ApiResponse<T>

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

Formats the value using the given formatter.

impl<'r, T> Responder<'r, 'static> for ApiResponse<T> where
    T: Serialize, 

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.