Struct ServiceResult 

pub struct ServiceResult<T: Serialize> {
    pub status: String,
    pub message: String,
    pub data: Option<T>,
    pub code: u16,
    pub response_type: ResponseType,
    /* private fields */
}

Standard success envelope: serializes as {"status","message","data"} unless ServiceResult::stripped is used, in which case only data is serialized. Type parameter T is the data payload. code and response_type control the HTTP status and content type but are not serialized into the body.

Fields

status: String

Envelope status label (e.g. "success").

message: String

Human-readable message.

data: Option<T>

Optional payload serialized as data.

code: u16

HTTP status code for the response.

response_type: ResponseType

Content type used when rendering the response.

Implementations

impl<T: Serialize> ServiceResult<T>

pub fn new( status: impl Into<String>, message: impl Into<String>, data: Option<T>, code: u16, ) -> Self

Creates a result with an explicit status label, message, optional payload, and HTTP code.

pub fn ok(message: impl Into<String>, data: T) -> Self

Creates a 200 success result with status "success", the given message, and data.

pub fn ok_empty(message: impl Into<String>) -> Self

where T: Default,

Creates a 200 success result with status "success" and no payload.

pub fn stripped(self) -> Self

Serializes only the data field instead of the status/message/data envelope.

pub fn with_response_type(self, rt: ResponseType) -> Self

Overrides the content type used when rendering this result.

pub fn with_code(self, code: u16) -> Self

Overrides the HTTP status code used when rendering this result.

pub fn boxed(self) -> Box<dyn TypedServiceResult>

where T: Send + Sync + 'static,

Boxes this result so one handler can return different ServiceResult<T> payload shapes.

pub fn serialize_inherent(&self) -> Result<String, Error>

Serializes the result body directly; the trait serialize delegates to this. A stripped result serializes only data, otherwise the full envelope is used.

Trait Implementations

impl<T: Clone + Serialize> Clone for ServiceResult<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Serialize> Debug for ServiceResult<T>

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

Formats the value using the given formatter.

impl<T> Serialize for ServiceResult<T>

where T: Serialize + Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Serialize + Send + Sync> TypedServiceResult for ServiceResult<T>

fn message(&self) -> &str

Human-readable message carried by the result.

fn code(&self) -> u16

HTTP status code used for the response.

fn response_type(&self) -> ResponseType

Content type used for the Content-Type header.

fn serialize(&self) -> Result<String, Error>

Renders the response body; I/O or shape errors surface as serde_json::Error.

fn data_json(&self) -> Option<Value>

Returns the payload as JSON when representable; defaults to None.