Struct Envelope 

pub struct Envelope {
    pub kind: Kind,
    pub request_id: u64,
    pub method: String,
    pub args: Vec<Arg>,
    pub payload: Vec<u8>,
    pub caps: Vec<CapDescriptor>,
    pub redact: bool,
    pub read_only: bool,
}

One Active RPC envelope.

Fields

kind: Kind

Envelope kind.

request_id: u64

Request id, echoed by the response.

method: String

Method name (requests) or error code (errors).

args: Vec<Arg>

Arguments, in order.

payload: Vec<u8>

Optional Infinity payload (module bytes).

caps: Vec<CapDescriptor>

Capability descriptors travelling with this envelope.

redact: bool

Redaction hint.

read_only: bool

Read-only hint.

Implementations

impl Envelope

pub fn request( request_id: u64, method: impl Into<String>, args: Vec<Arg>, ) -> Self

A request envelope.

pub fn response(request_id: u64, value: Value) -> Self

A response envelope.

pub fn error(request_id: u64, error: &Error) -> Self

An error envelope.

pub fn with_payload(self, payload: Vec<u8>) -> Self

Attach an Infinity payload.

pub fn with_caps(self, caps: Vec<CapDescriptor>) -> Self

Attach capability descriptors.

pub fn encode(&self) -> Result<Vec<u8>>

Serialize.

pub fn decode(bytes: &[u8]) -> Result<Envelope>

Parse with default limits.

pub fn decode_with(bytes: &[u8], limits: WireLimits) -> Result<Envelope>

Parse with explicit limits.

pub fn first_value(&self) -> Option<&Value>

The first value argument, when present.

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 PartialEq for Envelope

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Envelope