Struct OperationResult 

pub struct OperationResult<T = ()> {
    pub success: bool,
    pub status: i32,
    pub message: String,
    pub result: Option<T>,
}

Outcome of an operation: success flag, business status, message, and — for OperationResult<T> — the business payload.

OperationResult (the default T = ()) has no result member at all, so update/delete-style endpoints can report the outcome without declaring a one-off type. The fields are public; the constructors keep success and status agreeing with each other.

Fields

success: bool

Whether the operation achieved its goal.

status: i32

Business status code, defined by the caller (the constructors use 0 when no explicit code is given). It is not an HTTP status: the transport layer never reads it.

message: String

Human-readable outcome for the caller (UI toast, CLI output, logs).

result: Option<T>

The business payload; omitted from JSON when absent (the unit form, or a failed result).

Implementations

impl<T> OperationResult<T>

pub fn ok(result: T, message: impl Into<String>) -> OperationResult<T>

A successful result carrying result, with the default business status 0.

pub fn ok_with_status( status: i32, result: T, message: impl Into<String>, ) -> OperationResult<T>

A successful result carrying result and an explicit business status.

pub fn failed(status: i32, message: impl Into<String>) -> OperationResult<T>

A failed result with the business status that explains why. No payload is attached.

pub fn with_status(self, status: i32) -> OperationResult<T>

Replace the business status, keeping success and the message.

Use it when the outcome is only known part-way through the operation (result = result.with_status(1001)); the fields are public as well, so result.status = 1001 works too.

pub fn with_message(self, message: impl Into<String>) -> OperationResult<T>

Replace the message, keeping success and the business status.

impl OperationResult

pub fn success(message: impl Into<String>) -> OperationResult

A successful result with no payload, and the default business status 0.

The JSON body is {"success":true,"status":0,"message":"..."}.

pub fn success_with_status( status: i32, message: impl Into<String>, ) -> OperationResult

A successful result with no payload and an explicit business status.

pub fn with_result<T>(self, result: T) -> OperationResult<T>

Attach the business payload once it is known, turning the unit envelope into OperationResult<T>; success, status and message are kept.

Trait Implementations

impl<T> Clone for OperationResult<T>

where T: Clone,

fn clone(&self) -> OperationResult<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for OperationResult<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Serialize for OperationResult<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.