Skip to main content

UnifiedResponse

Struct UnifiedResponse 

Source
pub struct UnifiedResponse {
    pub CorrelationIdentifier: CorrelationId,
    pub Success: bool,
    pub Payload: Vec<u8>,
    pub Error: Option<ResponseError>,
    pub Metadata: HashMap<String, String>,
    pub GeneratedAt: Timestamp,
}
Expand description

A unified response message that can be received over any transport.

Fields§

§CorrelationIdentifier: CorrelationId

Correlation ID matching the request.

§Success: bool

Success flag indicating whether the operation completed successfully.

§Payload: Vec<u8>

Binary payload containing the serialized result (if Success = true).

§Error: Option<ResponseError>

Error information when Success = false.

§Metadata: HashMap<String, String>

Additional response metadata.

§GeneratedAt: Timestamp

Timestamp when the response was generated (microseconds since Unix epoch).

Implementations§

Source§

impl UnifiedResponse

Source

pub fn Success(CorrelationIdentifier: CorrelationId, Payload: Vec<u8>) -> Self

Creates a new successful response with the given correlation ID and payload.

Source

pub fn Failure( CorrelationIdentifier: CorrelationId, Error: ResponseError, Payload: Option<Vec<u8>>, ) -> Self

Creates a new error response with the given correlation ID and error.

Source

pub fn FromTransportError( CorrelationIdentifier: CorrelationId, TransportError: &TransportError, ) -> Self

Creates a new error response from a TransportError.

Source

pub fn WithMetadata( self, Key: impl Into<String>, Value: impl Into<String>, ) -> Self

Adds metadata to the response.

Source

pub fn WithMetadataMap(self, Metadata: HashMap<String, String>) -> Self

Sets the entire metadata map.

Source

pub fn ErrorCode(&self) -> Option<TransportErrorCode>

Gets the error code if this is an error response.

Source

pub fn IsSuccess(&self) -> bool

Checks if this response is a success.

Source

pub fn IsError(&self) -> bool

Checks if this response is an error.

Source

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

Validates the response.

Trait Implementations§

Source§

impl Clone for UnifiedResponse

Source§

fn clone(&self) -> UnifiedResponse

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for UnifiedResponse

Source§

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

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

impl<'de> Deserialize<'de> for UnifiedResponse

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for UnifiedResponse

Source§

fn eq(&self, other: &UnifiedResponse) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for UnifiedResponse

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

impl Eq for UnifiedResponse

Source§

impl StructuralPartialEq for UnifiedResponse

Auto Trait Implementations§

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
§

impl<'de, D, R> CommandArg<'de, R> for D
where D: Deserialize<'de>, R: Runtime,

§

fn from_command(command: CommandItem<'de, R>) -> Result<D, InvokeError>

Derives an instance of Self from the [CommandItem]. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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.

§

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

§

fn body(self) -> Result<InvokeResponseBody, Error>

Resolve the IPC response body.
§

impl<T> ScopeObject for T
where T: Send + Sync + Debug + DeserializeOwned + 'static,

§

type Error = Error

The error type.
§

fn deserialize<R>( _app: &AppHandle<R>, raw: Value, ) -> Result<T, <T as ScopeObject>::Error>
where R: Runtime,

Deserialize the raw scope value.
Source§

impl<T> Serialize for T
where T: Serialize + ?Sized,

Source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

Source§

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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> AutoreleaseSafe for T
where T: ?Sized,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> UserEvent for T
where T: Debug + Clone + Send + 'static,