Struct Envelope 

pub struct Envelope {
    pub v: u32,
    pub id: RequestId,
    pub op: String,
    pub ok: Option<bool>,
    pub payload: Option<Value>,
    pub error: Option<ProtocolError>,
}

Envelope wrapping every worker message.

Fields

v: u32

Protocol version.

id: RequestId

Correlation id.

op: String

Operation name.

ok: Option<bool>

Success flag (responses only; omitted on requests).

payload: Option<Value>

Payload.

error: Option<ProtocolError>

Structured error (responses only).

Implementations

impl Envelope

pub fn request(op: impl Into<String>, payload: Value) -> Self

Build a request envelope.

pub fn ok_response(id: RequestId, op: impl Into<String>, payload: Value) -> Self

Build a successful response.

pub fn err_response( id: RequestId, op: impl Into<String>, error: ProtocolError, ) -> Self

Build an error response.

pub fn to_ndjson_line(&self) -> Result<String>

Encode as a single NDJSON line (with trailing newline).

pub fn from_ndjson_line(line: &str) -> Result<Self>

Parse a single NDJSON line.

Trait Implementations

impl Clone for Envelope

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 Envelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Envelope

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Envelope

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

where __S: Serializer,

Serialize this value into the given Serde serializer.