Struct ResponseEnvelope 

pub struct ResponseEnvelope {
    pub status: ResponseStatus,
    pub payload: Option<Value>,
    pub error_code: Option<u32>,
    pub error_message: Option<String>,
    pub request_id: Option<u64>,
}

Response envelope wrapping a response for FFI transport

Fields

status: ResponseStatus

Response status

payload: Option<Value>

Serialized response payload (on success) or null

error_code: Option<u32>

Error code (on failure)

error_message: Option<String>

Error message (on failure)

request_id: Option<u64>

Original request ID for correlation

Implementations

impl ResponseEnvelope

pub fn success(payload: Value) -> ResponseEnvelope

Create a success response with payload

pub fn success_typed<T>(value: &T) -> Result<ResponseEnvelope, Error>

where T: Serialize,

Create a success response from a serializable value

pub fn success_raw(data: &[u8]) -> Result<ResponseEnvelope, Error>

Create a success response from raw bytes (already JSON-encoded)

pub fn error(code: u32, message: impl Into<String>) -> ResponseEnvelope

Create an error response

pub fn from_error(err: &PluginError) -> ResponseEnvelope

Create an error response from a PluginError

pub fn with_request_id(self, id: u64) -> ResponseEnvelope

Set request ID for correlation

pub fn is_success(&self) -> bool

Check if this is a success response

pub fn payload_as<T>(&self) -> Result<Option<T>, Error>

where T: DeserializeOwned,

Get the payload if success

This method deserializes directly from the JSON value without cloning.

pub fn to_bytes(&self) -> Result<Vec<u8>, Error>

Serialize to bytes for FFI transport

pub fn from_bytes(data: &[u8]) -> Result<ResponseEnvelope, Error>

Deserialize from bytes

Trait Implementations

impl Clone for ResponseEnvelope

fn clone(&self) -> ResponseEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseEnvelope

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

Formats the value using the given formatter.

impl Default for ResponseEnvelope

fn default() -> ResponseEnvelope

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ResponseEnvelope

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ResponseEnvelope

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.