Struct Header 

pub struct Header {
    pub method_id: u16,
    pub flags: u8,
    pub request_id: u32,
    pub payload_length: u32,
}

Decoded header from wire format.

Fields

method_id: u16

Method identifier (1-65534, 0 reserved, 0xFFFF = abort).

flags: u8

Flags byte (see flags module).

request_id: u32

Request identifier (0 = event/fire-and-forget).

payload_length: u32

Payload length in bytes.

Implementations

impl Header

pub fn new( method_id: u16, flags: u8, request_id: u32, payload_length: u32, ) -> Self

Create a new header.

pub fn encode(&self) -> [u8; 11]

Encode header to bytes (Big Endian).

Example

use procwire_client::protocol::{Header, flags};

let header = Header::new(1, flags::RESPONSE, 42, 100);
let bytes = header.encode();
assert_eq!(bytes.len(), 11);

pub fn encode_into(&self, buf: &mut [u8])

Encode header into an existing buffer.

Panics

Panics if buffer is smaller than HEADER_SIZE (11 bytes).

pub fn decode(buf: &[u8]) -> Option<Self>

Decode header from bytes (Big Endian).

Returns None if buffer is too short.

Example

use procwire_client::protocol::Header;

let bytes = [0, 1, 0x03, 0, 0, 0, 42, 0, 0, 0, 100];
let header = Header::decode(&bytes).unwrap();
assert_eq!(header.method_id, 1);
assert_eq!(header.request_id, 42);
assert_eq!(header.payload_length, 100);

pub fn validate(&self, max_payload_size: u32) -> Result<()>

Validate the header for protocol compliance.

Checks:

• Method ID is not 0 (reserved)
• Payload length doesn’t exceed max
• Reserved flag bits are 0

pub fn is_abort(&self) -> bool

Check if this is an abort signal.

pub fn is_response(&self) -> bool

Check if this is a response.

pub fn is_error(&self) -> bool

Check if this is an error response.

pub fn is_stream(&self) -> bool

Check if this is a stream chunk.

pub fn is_stream_end(&self) -> bool

Check if this is the final stream chunk.

pub fn is_ack(&self) -> bool

Check if this is an ACK.

pub fn is_to_parent(&self) -> bool

Check if direction is to parent.

pub fn is_event(&self) -> bool

Check if this is an event (request_id == 0).

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl PartialEq for Header

fn eq(&self, other: &Header) -> 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 Copy for Header

impl Eq for Header

impl StructuralPartialEq for Header