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 a std::io::Take 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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd 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 RequestBuilder for Header

fn new_request<M, T>(method: M, target: T) -> Self

where M: IntoBytes, T: IntoBytes,

Creates a new request

fn set_header<K, V>(self, key: K, value: V) -> Self

where K: IntoBytes, V: IntoBytes,

Sets an arbitrary header key-value pair

fn set_content_length<T>(self, length: T) -> Self

where T: IntoBytes,

Sets the “Content-Length” header for self

impl RequestHeader for Header

fn from_stdin() -> Result<(Self, BufReader<Stdin>), Error>

Reads Self from stdin (e.g. in CGI contexts)

fn method(&self) -> &[u8]

The request method

fn target(&self) -> &[u8]

The request target URL

fn version(&self) -> &[u8]

The request HTTP version

impl ResponseBuilder for Header

fn new_response<S, R>(status: S, reason: R) -> Self

where S: IntoBytes, R: IntoBytes,

Creates a new response

fn set_header<K, V>(self, key: K, value: V) -> Self

where K: IntoBytes, V: IntoBytes,

Sets an arbitrary header key-value pair

fn set_content_type<T>(self, type_: T) -> Self

where T: IntoBytes,

Sets the status/reason tuple for self

fn set_content_length<T>(self, length: T) -> Self

where T: IntoBytes,

Sets the “Content-Length” header for self

impl ResponseHeader for Header

fn from_stdin() -> Result<(Self, BufReader<Stdin>), Error>

Reads Self from stdin (e.g. in CGI contexts)

fn status(&self) -> &[u8]

The response status code

fn reason(&self) -> &[u8]

The response status reason

fn version(&self) -> &[u8]

The response HTTP version

impl Eq for Header

impl StructuralEq for Header

impl StructuralPartialEq for Header