Struct stream_httparse::Headers

pub struct Headers<'a> { /* fields omitted */ }

A collection of Headers

Implementations

impl<'a> Headers<'a>

pub fn new() -> Self

Creates a new Headers-Instance, for performance reasons it is recommended to use the with_capacity method as that would avoid frequent reallocations

pub fn with_capacity(cap: usize) -> Self

Creates the Headers-Object with the given Capacity prereserved for future Headers. This should be used when you already kind of know how many Headers this will hold, as it will avoid extra allocations in the future

pub fn set<'b, K, V>(&mut self, key: K, value: V) where
    'b: 'a,
    K: Into<HeaderKey<'a>>,
    V: Into<HeaderValue<'a>>, 

Sets the Value of the of the Header for the given Key to the given Value

Behaviour

Checks if the Key is already present in the Collection and removes it if that is the case. Then adds the new Header to the End of the Collection

pub fn append<K, V>(&mut self, key: K, value: V) where
    K: Into<HeaderKey<'a>>,
    V: Into<HeaderValue<'a>>, 

Appends the given Key-Value Pair to the end of the Collection, without checking if the Key is already present in the Collection

pub fn remove<K>(&mut self, key: K) where
    K: Into<HeaderKey<'a>>, 

Removes the first Header, that matches the given Key, from the Collection

pub fn get<K>(&self, key: K) -> Option<&HeaderValue<'a>> where
    K: Into<HeaderKey<'a>>, 

Searches the Collection for a Header that matches the given Key

Returns:

• None: if no Header matches the Key
• A Reference to the underlying Header-Value that belongs to the Key

pub fn serialize(&self, buf: &mut Vec<u8>)

Serializes the Collection of Headers into the given Buffer by append to it

pub fn get_max_value_size(&self) -> usize

Returns the Size in bytes of the biggest Value as text.

This means that all the Header-Values in this collection can fit in a buffer of this size.

pub fn get_header_count(&self) -> usize

Returns the Number of Headers in this collection

pub fn to_owned<'refed, 'owned>(&'refed self) -> Headers<'owned>

Clones all the assosicated Data to produce a new and independant Header-Collection

Trait Implementations

impl<'a> Clone for Headers<'a>

fn clone(&self) -> Headers<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Headers<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Headers<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> PartialEq<Headers<'a>> for Headers<'a>

fn eq(&self, other: &Headers<'a>) -> bool

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

fn ne(&self, other: &Headers<'a>) -> bool

This method tests for !=.

impl<'a> StructuralPartialEq for Headers<'a>