Struct NvPair 

pub struct NvPair {
    pub name: Bytes,
    pub value: Bytes,
}

Available on crate feature fastcgi only.

A single FastCGI name-value pair (owned).

Used in FCGI_PARAMS and FCGI_GET_VALUES records to carry CGI environment variables or capability queries.

Reference: FastCGI Specification §3.4

Fields

name: Bytes

value: Bytes

Implementations

impl NvPair

pub fn new(name: impl Into<Bytes>, value: impl Into<Bytes>) -> NvPair

Create a new owned NvPair.

pub fn encoded_len(&self) -> usize

Number of bytes this pair occupies when encoded.

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

where B: BufMut,

Write this pair into the buffer using FastCGI encoding.

Returns ProtocolError::ContentTooLarge if either the name or value length exceeds MAX_NV_LENGTH (2^31 − 1).

Reference: FastCGI Specification §3.4

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

where W: AsyncWrite + Unpin,

Write this pair to a writer using FastCGI encoding.

Reference: FastCGI Specification §3.4

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

where R: AsyncRead + Unpin,

Read a single NvPair from the reader.

Rejects pairs whose declared name + value length would exceed max_pair_bytes before allocating, returning ProtocolError::ContentTooLarge. This guards against peer-controlled length fields (up to 2^31 − 1 per side per the FastCGI spec) from triggering multi-gigabyte allocations.

Note on cancellation: this function performs multiple sequential awaits (length, length, bytes, bytes). A future dropped mid-read can leave the stream desynced. Use decode_params over a pre-read, already-capped buffer (as the crate’s framing layer does) when cancellation safety matters.

Reference: FastCGI Specification §3.4

Trait Implementations

impl Clone for NvPair

fn clone(&self) -> NvPair

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NvPair

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

Formats the value using the given formatter.

impl PartialEq for NvPair

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

impl StructuralPartialEq for NvPair