Struct Frame 

pub struct Frame {
    pub envelope_version: u32,
    pub kind: i32,
    pub payload_protocol: u32,
    pub payload: Vec<u8>,
    pub request_id: u64,
    pub payload_encoding: i32,
    pub deadline_unix_ms: u64,
    pub traceparent: String,
    pub tracestate: String,
}

Every control-plane frame on a broker connection.

Fields

envelope_version: u32

ALWAYS 1 in v1 broker. Frozen.

kind: i32

payload_protocol: u32

0x00 for Hello/HelloReply; 0xAD01 for admin verbs

payload: Vec<u8>

OPAQUE for non-control kinds

request_id: u64

payload_encoding: i32

deadline_unix_ms: u64

traceparent: String

W3C trace context

tracestate: String

Implementations

impl Frame

pub fn kind(&self) -> FrameKind

Returns the enum value of kind, or the default if the field is set to an invalid enum value.

pub fn set_kind(&mut self, value: FrameKind)

Sets kind to the provided enum value.

pub fn payload_encoding(&self) -> PayloadEncoding

Returns the enum value of payload_encoding, or the default if the field is set to an invalid enum value.

pub fn set_payload_encoding(&mut self, value: PayloadEncoding)

Sets payload_encoding to the provided enum value.

impl Frame

pub fn request(payload_protocol: u32, payload: Vec<u8>) -> Self

Build a v1 request frame with correct envelope defaults.

Sets envelope_version to PROTOCOL_VERSION, kind to REQUEST, payload_encoding to NONE, no deadline, and empty trace context. Callers correlate request/response pairs through request_id (see Frame::with_request_id).

use running_process::broker::protocol::Frame;

let frame = Frame::request(0x7A63, b"payload".to_vec()).with_request_id(7);
assert_eq!(frame.envelope_version, 1);
assert_eq!(frame.request_id, 7);

pub fn response_to(request: &Self, payload: Vec<u8>) -> Self

Build the v1 response frame for request.

Echoes the request’s payload_protocol, request_id, and trace context, sets kind to RESPONSE, and carries payload.

use running_process::broker::protocol::Frame;

let request = Frame::request(0x7A63, b"ping".to_vec()).with_request_id(9);
let response = Frame::response_to(&request, b"pong".to_vec());
assert_eq!(response.request_id, 9);
assert_eq!(response.payload_protocol, 0x7A63);

pub fn with_request_id(self, request_id: u64) -> Self

Set the correlation request_id (builder style).

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Default for Frame

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Frame

impl Hash for Frame

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for Frame

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Frame

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Frame