Struct RecordHeader 

pub struct RecordHeader {
    pub record_type: RecordType,
    pub request_id: u16,
    pub content_length: u16,
    pub padding_length: u8,
}

Available on crate feature fastcgi only.

The 8-byte header that precedes every FastCGI record.

+---------+---------+-----------+-----------+---------------+-----------+---------+
| version | type    | requestId             | contentLength | paddingLen| reserved|
+---------+---------+-----------+-----------+---------------+-----------+---------+
|    1    |    1    |     1     |     1     |      1    1   |     1     |    1    |
+---------+---------+-----------+-----------+---------------+-----------+---------+

• version is always FCGI_VERSION_1 (1).
• type identifies the record type.
• requestId identifies the request this record belongs to; 0 for management records.
• contentLength is the number of bytes of content following the header.
• paddingLength is the number of padding bytes following the content.
• reserved must be zero.

Reference: FastCGI Specification §3.3

Fields

record_type: RecordType

request_id: u16

0 for management records; 1–65535 for application records.

content_length: u16

Number of content bytes following this header (0–65535).

padding_length: u8

Number of padding bytes following the content (0–255).

Implementations

impl RecordHeader

pub fn new( record_type: RecordType, request_id: u16, content_length: u16, ) -> RecordHeader

Create a new RecordHeader for an application record (non-zero requestId).

pub fn management(record_type: RecordType, content_length: u16) -> RecordHeader

Create a new RecordHeader for a management record (requestId == 0).

pub async fn read_from<R>(r: &mut R) -> Result<RecordHeader, ProtocolError>

where R: AsyncRead + Unpin,

Read a RecordHeader from the reader.

Reads all 8 bytes in a single read_exact call so the header is parsed atomically: a future dropped mid-read either consumes the full header or none of it (modulo what read_exact itself buffers), preventing stream desync on a kept-alive connection.

Reference: FastCGI Specification §3.3

pub async fn write_to<W>(&self, w: &mut W) -> Result<(), Error>

where W: AsyncWrite + Unpin,

Write this RecordHeader to the writer.

Reference: FastCGI Specification §3.3

pub fn write_to_buf<B>(&self, buf: &mut B)

where B: BufMut,

Write this RecordHeader into the buffer.

Reference: FastCGI Specification §3.3

Trait Implementations

impl Clone for RecordHeader

fn clone(&self) -> RecordHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecordHeader

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

Formats the value using the given formatter.

impl PartialEq for RecordHeader

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

impl StructuralPartialEq for RecordHeader