Skip to main content

OperationResult

Struct OperationResult 

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

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§

Source§

impl<T> OperationResult<T>

Source

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

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

Source

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

A successful result carrying result and an explicit business status.

Source

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

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

Source§

impl OperationResult<()>

Source

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

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

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

Source

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

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

Trait Implementations§

Source§

impl<T: Clone> Clone for OperationResult<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for OperationResult<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Serialize for OperationResult<T>
where T: Serialize,

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<T> Forget for OperationResult<T>

§

impl<T> Freeze for OperationResult<T>
where Option<T>: Freeze,

§

impl<T> Move for OperationResult<T>

§

impl<T> RefUnwindSafe for OperationResult<T>

§

impl<T> Send for OperationResult<T>
where Option<T>: Send,

§

impl<T> Sync for OperationResult<T>
where Option<T>: Sync,

§

impl<T> Unpin for OperationResult<T>
where Option<T>: Unpin,

§

impl<T> UnsafeUnpin for OperationResult<T>
where Option<T>: UnsafeUnpin,

§

impl<T> UnwindSafe for OperationResult<T>
where Option<T>: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more