Struct HopByHopHeaderContext 

pub struct HopByHopHeaderContext { /* private fields */ }

Available on crate features http and std only.

Connection-specific metadata captured while sanitizing an HTTP message.

This type supports intermediaries that consume hop-by-hop fields and then originate equivalent fields for the next hop. It deliberately retains only valid HTTP/1.1 upgrade intent, TE: trailers capability, and non-nominated trailer declarations.

Implementations

impl HopByHopHeaderContext

pub fn capture(headers: &HeaderMap, version: Version) -> HopByHopHeaderContext

Capture connection-specific metadata without modifying the headers.

pub fn take(headers: &mut HeaderMap, version: Version) -> HopByHopHeaderContext

Capture connection-specific metadata and remove all hop-by-hop fields.

pub fn nominated_headers(&self) -> &[HeaderName]

Return the fields nominated by the original Connection header.

pub fn restore_trailer_headers(&self, headers: &mut HeaderMap, version: Version)

Restore captured Trailer fields for a target that supports trailers.

An existing target field takes precedence over the captured fields.

pub fn restore_response( &self, headers: &mut HeaderMap, version: Version, target_nominations: &[HeaderName], )

Restore response metadata needed to originate the next hop.

This is intended for a transformation of the same response, such as adaptation. It does not correlate a response with its request; relays should use sanitize_hop_by_hop_response_headers for that validation.

The target headers are expected to have been sanitized first. Trailer declarations remain removed when either the source or target nominated Trailer as connection-specific.

pub fn restore_request( &self, headers: &mut HeaderMap, version: Version, target_nominations: &[HeaderName], )

Restore metadata for an adapted or otherwise re-originated request.

In addition to common message metadata, this restores the normalized TE: trailers capability required by the target HTTP version.

Trait Implementations

impl Clone for HopByHopHeaderContext

fn clone(&self) -> HopByHopHeaderContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HopByHopHeaderContext

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

Formats the value using the given formatter.

impl Default for HopByHopHeaderContext

fn default() -> HopByHopHeaderContext

Returns the “default value” for a type.