Struct http_header::Header

pub struct Header {
    pub status_line: (Data<Ascii>, Data<Ascii>, Data<Ascii>),
    pub fields: HashMap<Data<HeaderFieldKey>, Data<Ascii>>,
}

A generic HTTP/1.* header implementation

Can be converted into a RequestHeader/ResponseHeader using the TryFrom/TryInto-traits

Fields

status_line: (Data<Ascii>, Data<Ascii>, Data<Ascii>)

The header status line

fields: HashMap<Data<HeaderFieldKey>, Data<Ascii>>

The header fields

Methods

impl Header

pub fn scan(data: &[u8]) -> Option<(&[u8], &[u8])>

Checks if data starts with a header-like structure and returns either Some((header, body)) or None if no header-like structure was found

pub fn read(source: impl Read, buf: &mut [u8]) -> Result<Option<usize>, Error>

Reads from source into buf until a HTTP-header-end is matched or buf is filled completely

Returns either Some(header_len) if the header end has been matched or None if buf has been filled completely without a match.

pub fn parse(bytes: &[u8]) -> Result<Self, HttpError>

Parses a HTTP request header from bytes

pub fn write(&self, sink: impl WriteExt) -> Result<usize, Error>

Serializes and writes the header to sink and returns the amount of bytes written

pub fn to_vec(&self) -> Vec<u8>

Serializes the header into a vector

Trait Implementations

impl AsRef<Header> for RequestHeader

fn as_ref(&self) -> &Header

Performs the conversion.

impl AsRef<Header> for ResponseHeader

fn as_ref(&self) -> &Header

Performs the conversion.

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<RequestHeader> for Header

fn from(s: RequestHeader) -> Self

Performs the conversion.

impl From<ResponseHeader> for Header

fn from(s: ResponseHeader) -> Self

Performs the conversion.

impl Debug for Header

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

Formats the value using the given formatter.

impl TryFrom<Header> for RequestHeader

type Error = HttpError

The type returned in the event of a conversion error.

fn try_from(header: Header) -> Result<Self, Self::Error>

Tries to create a RequestHeader from a Header

impl TryFrom<Header> for ResponseHeader

type Error = HttpError

The type returned in the event of a conversion error.

fn try_from(header: Header) -> Result<Self, Self::Error>

Tries to create a RequestHeader from a Header