Struct DataResponseEnvelope 

pub struct DataResponseEnvelope { /* private fields */ }

A historical payload and the completion state of its root request.

A terminal envelope can omit its payload, including when a request fails before returning data. sub_correlation_id identifies a source child without changing the root correlation ID.

Implementations

impl DataResponseEnvelope

pub fn new( response: DataResponse, completed: bool, sub_correlation_id: Option<UUID4>, ) -> Self

Creates an envelope containing a payload.

pub fn terminal(correlation_id: UUID4, failure_reason: Option<String>) -> Self

Completes a request without a payload. A reason marks the request as failed.

pub fn with_correlation_id(self, correlation_id: UUID4) -> Self

Sets the root request ID while preserving the payload correlation ID.

pub fn with_failure(self, reason: String) -> Self

Completes a failed request while preserving the payload returned by successful work.

pub const fn correlation_id(&self) -> &UUID4

pub const fn response(&self) -> Option<&DataResponse>

pub const fn response_mut(&mut self) -> Option<&mut DataResponse>

Returns the payload for in-place metadata updates or bounds trimming.

pub const fn completed(&self) -> bool

pub const fn sub_correlation_id(&self) -> Option<UUID4>

pub fn failure_reason(&self) -> Option<&str>

Trait Implementations

impl Clone for DataResponseEnvelope

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataResponseEnvelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DataResponseEnvelope

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Serialize for DataResponseEnvelope

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

where __S: Serializer,

Serialize this value into the given Serde serializer.