Struct ResponseHeader 

pub struct ResponseHeader { /* private fields */ }

The HTTP response header type.

This type is similar to http::response::Parts but preserves header name case. ResponseHeader implements Deref for http::response::Parts so it can be used as it in most places. Mutable access to the underlying parts is intentionally not provided because header mutations must use methods on ResponseHeader to preserve its internal state.

use pingora_http::ResponseHeader;

let mut response = ResponseHeader::build(200, None).unwrap();
response.headers.remove("server");

Implementations

impl ResponseHeader

pub fn build( code: impl TryInto<StatusCode>, size_hint: Option<usize>, ) -> Result<Self>

Create a new ResponseHeader with the given status code.

pub fn build_no_case( code: impl TryInto<StatusCode>, size_hint: Option<usize>, ) -> Result<Self>

Create a new ResponseHeader with the given status code without preserving header case.

A ResponseHeader created from this type is more space efficient than those from Self::build().

Use this method if reading from or writing to HTTP/2 sessions where header case doesn’t matter anyway.

pub fn append_header( &mut self, name: impl IntoCaseHeaderName, value: impl TryInto<HeaderValue>, ) -> Result<bool>

Append the header name and value to self.

If there are already some headers under the same name, a new value will be added without any others being removed.

pub fn insert_header( &mut self, name: impl IntoCaseHeaderName, value: impl TryInto<HeaderValue>, ) -> Result<()>

Insert the header name and value to self.

Different from Self::append_header(), this method will replace all other existing headers under the same name (case insensitive).

pub fn remove_header<'a, N: ?Sized>( &mut self, name: &'a N, ) -> Option<HeaderValue>

where &'a N: 'a + AsHeaderName,

Remove all headers under the name

pub fn header_to_h1_wire(&self, buf: &mut impl BufMut)

Write the header to the buf in HTTP/1.1 wire format.

The header case will be preserved.

pub fn case_header_iter( &self, ) -> impl Iterator<Item = (&CaseHeaderName, &HeaderValue)> + '_

If case sensitivity is enabled, returns an iterator to iterate over case-sensitive header names and values. Otherwise returns an empty iterator.

Headers of the same name are visited in insertion order.

pub fn has_case(&self) -> bool

Returns true if the response has case-sensitive headers.

pub fn map<F: FnMut(HeaderNameVariant<'_>, &HeaderValue) -> Result<()>>( &self, f: F, ) -> Result<()>

pub fn extensions_mut(&mut self) -> &mut Extensions

Return mutable access to the response extensions.

pub fn set_status(&mut self, status: impl TryInto<StatusCode>) -> Result<()>

Set the status code

pub fn set_version(&mut self, version: Version)

Set the HTTP version

pub fn set_reason_phrase(&mut self, reason_phrase: Option<&str>) -> Result<()>

Set the HTTP reason phase. If None, a default reason phase will be used

pub fn get_reason_phrase(&self) -> Option<&str>

Get the HTTP reason phase. If Self::set_reason_phrase() is never called or set to None, a default reason phase will be used

pub fn as_owned_parts(&self) -> RespParts

Clone self into http::response::Parts.

pub fn set_content_length(&mut self, len: usize) -> Result<()>

Helper function to set the HTTP content length on the response header.

Trait Implementations

impl AsRef<Parts> for ResponseHeader

fn as_ref(&self) -> &RespParts

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ResponseHeader

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseHeader

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

Formats the value using the given formatter.

impl Deref for ResponseHeader

type Target = Parts

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<Box<ResponseHeader>> for Box<Parts>

fn from(resp: Box<ResponseHeader>) -> Box<RespParts>

Converts to this type from the input type.

impl From<Parts> for ResponseHeader

fn from(parts: RespParts) -> ResponseHeader

Converts to this type from the input type.

impl From<ResponseHeader> for Parts

fn from(resp: ResponseHeader) -> RespParts

Converts to this type from the input type.