Struct http_tiny::Header

pub struct Header { /* private fields */ }

A HTTP header

Implementations

impl Header

pub const fn new(start_line: HeaderStartLine, fields: HeaderFields) -> Self

Creates a new HTTP/1.1 header

pub fn start_line(&self) -> &HeaderStartLine

The start line

pub fn start_line_mut(&mut self) -> &mut HeaderStartLine

The start line

pub fn fields(&self) -> &HeaderFields

The header fields

pub fn fields_mut(&mut self) -> &mut HeaderFields

The header fields

pub fn read<T>(source: &mut T) -> Result<Self, Error> where
    T: BufRead, 

Loads a HTTP header from bytes and returns the remaining bytes

Warning:

This function will read forever until there is either a \r\n\r\n or an EOF. To prevent DOS-attacks, it is strongly recommended to wrap the source into an IoLimiter<T> to limit the amount of data that will be read.

pub fn write_all(&self, output: &mut dyn Write) -> Result<(), Error>

Writes the HTTP header

pub fn is_complete<T>(buf: T) -> bool where
    T: AsRef<[u8]>, 

Tests whether buf contains a complete header

Note

This function tests only, if buf contains an end-of-header marker (\r\n\r\n) - it does not perform any further parsing attempts or sanity checks.

Trait Implementations

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 Debug for Header

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

Formats the value using the given formatter.

impl Ord for Header

fn cmp(&self, other: &Header) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self where
    Self: PartialOrd<Self>, 

Restrict a value to a certain interval.

impl PartialEq<Header> for Header

fn eq(&self, other: &Header) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Header) -> bool

This method tests for !=.

impl PartialOrd<Header> for Header

fn partial_cmp(&self, other: &Header) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Header

impl StructuralEq for Header

impl StructuralPartialEq for Header