Header fields map. More...

#include <http_headers.hpp>

Inheritance diagram for restinio::http_header_fields_t:

Public Types
using	fields_container_t = std::vector< http_header_field_t >

using	const_iterator = fields_container_t::const_iterator
	Type of const_iterator for enumeration of fields. More...

Public Member Functions
	http_header_fields_t ()

	http_header_fields_t (const http_header_fields_t &)=default

	http_header_fields_t (http_header_fields_t &&)=default

virtual	~http_header_fields_t ()

http_header_fields_t &	operator= (const http_header_fields_t &)=default

http_header_fields_t &	operator= (http_header_fields_t &&)=default

void	swap_fields (http_header_fields_t &http_header_fields)

bool	has_field (string_view_t field_name) const noexcept
	Check field by name. More...

bool	has_field (http_field_t field_id) const noexcept
	Check field by field-id. More...

void	set_field (http_header_field_t http_header_field)
	Set header field via http_header_field_t. More...

void	set_field (std::string field_name, std::string field_value)
	Set field with string pair. More...

void	set_field (http_field_t field_id, std::string field_value)
	Set field with id-value pair. More...

void	append_field (string_view_t field_name, string_view_t field_value)
	Append field with name. More...

void	append_field (http_field_t field_id, string_view_t field_value)
	Append field with id. More...

const std::string &	get_field (string_view_t field_name) const
	Get field by name. More...

nullable_pointer_t< const std::string >	try_get_field (string_view_t field_name) const noexcept
	Try to get the value of a field by field name. More...

const std::string &	get_field (http_field_t field_id) const
	Get field by id. More...

nullable_pointer_t< const std::string >	try_get_field (http_field_t field_id) const noexcept
	Try to get the value of a field by field ID. More...

std::string	get_field_or (string_view_t field_name, string_view_t default_value) const
	Get field value by field name or default value if the field not found. More...

std::string	get_field_or (string_view_t field_name, std::string &&default_value) const
	Get field value by field name or default value if the field not found. More...

auto	get_field_or (string_view_t field_name, const char *default_value) const
	Get field by name or default value if the field not found. More...

auto	get_field_or (string_view_t field_name, const std::string &default_value) const
	Get field by name or default value if the field not found. More...

std::string	get_field_or (http_field_t field_id, string_view_t default_value) const
	Get field by id or default value if the field not found. More...

auto	get_field_or (http_field_t field_id, const char *default_value) const
	Get field by id or default value if the field not found. More...

auto	get_field_or (http_field_t field_id, const std::string &default_value) const
	Get field by id or default value if the field not found. More...

std::string	get_field_or (http_field_t field_id, std::string &&default_value) const
	Get field by id or default value if the field not found. More...

void	remove_field (string_view_t field_name)
	Remove field by name. More...

void	remove_field (http_field_t field_id)
	Remove field by id. More...

template<typename Lambda >
void	for_each_field (Lambda &&lambda) const noexcept(noexcept(lambda(std::declval< const http_header_field_t &>())))
	Enumeration of fields. More...

const_iterator	begin () const noexcept

const_iterator	end () const noexcept

auto	fields_count () const noexcept

Getters of field value which return string_view.
string_view_t	value_of (string_view_t name) const
	Get the value of a field or throw if the field not found. More...

string_view_t	value_of (http_field_t field_id) const
	Get the value of a field or throw if the field not found. More...

optional_t< string_view_t >	opt_value_of (string_view_t name) const noexcept
	Get optional value of a field. More...

optional_t< string_view_t >	opt_value_of (http_field_t field_id) const noexcept
	Get optional value of a field. More...

Private Member Functions
void	append_last_field (string_view_t field_value)
	Appends last added field. More...

fields_container_t::iterator	find (string_view_t field_name) noexcept

fields_container_t::const_iterator	cfind (string_view_t field_name) const noexcept

fields_container_t::iterator	find (http_field_t field_id) noexcept

fields_container_t::const_iterator	cfind (http_field_t field_id) const noexcept

Private Attributes
fields_container_t	m_fields

Friends
void	impl::append_last_field_accessor (http_header_fields_t &, string_view_t)

Detailed Description

Header fields map.

This class holds a collection of header fields.

There are 2 special cases for fields: Connection and Content-Length This cases are handled separetely from the rest of the fields. And as the implementation of http_header_fields_t doesn't have checks on each field manipulation checking whether field name is Connection or Content-Length it is important to use proper member functions in derived classes for manipulating them.

Getting values of fields

Since v.0.4.9 there are two groups of methods for accessing values of fields. The first group returns std::string (or references/pointers to std::string). This group includes the following methods: get_field(), get_field_or(), try_get_field().

The second group returns string_view_t or optional_t<string_view_t>. This group includes the following methods: value_of() and opt_value_of().

The first group was created in early versions of RESTinio and is present here for historical and compatibility reasons. They are not deprecated yet but they could be deprecated in newer versions of RESTinio. Because of that the usage of value_of() and opt_value_of() is more preferable.

Definition at line 764 of file http_headers.hpp.

Member Typedef Documentation

◆ const_iterator

using restinio::http_header_fields_t::const_iterator = fields_container_t::const_iterator

Type of const_iterator for enumeration of fields.

Definition at line 773 of file http_headers.hpp.

◆ fields_container_t

using restinio::http_header_fields_t::fields_container_t = std::vector< http_header_field_t >

Definition at line 770 of file http_headers.hpp.

Constructor & Destructor Documentation

◆ http_header_fields_t() [1/3]

restinio::http_header_fields_t::http_header_fields_t ( )

inline

Definition at line 775 of file http_headers.hpp.

◆ http_header_fields_t() [2/3]

restinio::http_header_fields_t::http_header_fields_t ( const http_header_fields_t & )

default

◆ http_header_fields_t() [3/3]

restinio::http_header_fields_t::http_header_fields_t ( http_header_fields_t && )

default

◆ ~http_header_fields_t()

virtual restinio::http_header_fields_t::~http_header_fields_t ( )

inlinevirtual

Definition at line 781 of file http_headers.hpp.

Member Function Documentation

◆ append_field() [1/2]

void restinio::http_header_fields_t::append_field	(	string_view_t	field_name,
		string_view_t	field_value
	)

inline

Append field with name.

Definition at line 889 of file http_headers.hpp.

◆ append_field() [2/2]

void restinio::http_header_fields_t::append_field	(	http_field_t	field_id,
		string_view_t	field_value
	)

inline

Append field with id.

If field_id=http_field_t::field_unspecified then function does nothing.

Definition at line 911 of file http_headers.hpp.

◆ append_last_field()

void restinio::http_header_fields_t::append_last_field ( string_view_t field_value )

inlineprivate

Appends last added field.

This is function is used by http-parser when field value is created by 2 separate invocation of on-header-field-value callback

Function doesn't check if at least one field exists, so it is not in the public interface.

Definition at line 1303 of file http_headers.hpp.

◆ begin()

const_iterator restinio::http_header_fields_t::begin ( ) const

inlinenoexcept

Definition at line 1276 of file http_headers.hpp.

◆ cfind() [1/2]

fields_container_t::const_iterator restinio::http_header_fields_t::cfind ( string_view_t field_name ) const

inlineprivatenoexcept

Definition at line 1320 of file http_headers.hpp.

◆ cfind() [2/2]

fields_container_t::const_iterator restinio::http_header_fields_t::cfind ( http_field_t field_id ) const

inlineprivatenoexcept

Definition at line 1342 of file http_headers.hpp.

◆ end()

const_iterator restinio::http_header_fields_t::end ( ) const

inlinenoexcept

Definition at line 1282 of file http_headers.hpp.

◆ fields_count()

auto restinio::http_header_fields_t::fields_count ( ) const

inlinenoexcept

Definition at line 1287 of file http_headers.hpp.

◆ find() [1/2]

fields_container_t::iterator restinio::http_header_fields_t::find ( string_view_t field_name )

inlineprivatenoexcept

Definition at line 1309 of file http_headers.hpp.

◆ find() [2/2]

fields_container_t::iterator restinio::http_header_fields_t::find ( http_field_t field_id )

inlineprivatenoexcept

Definition at line 1331 of file http_headers.hpp.

◆ for_each_field()

template<typename Lambda >

void restinio::http_header_fields_t::for_each_field ( Lambda && lambda ) const

inlinenoexcept

Enumeration of fields.

Calls lambda for each field in the container.

Lambda should have one of the following formats:

void(const http_header_field_t &);

void(http_header_field_t);

This method is noexcept if lambda is noexcept.

Usage example:

headers().for_each_field( [](const auto & f) {
    std::cout << f.name() << ": " << f.value() << std::endl;
} );

Definition at line 1267 of file http_headers.hpp.

◆ get_field() [1/2]

const std::string& restinio::http_header_fields_t::get_field ( string_view_t field_name ) const

inline

Get field by name.

Definition at line 932 of file http_headers.hpp.

◆ get_field() [2/2]

const std::string& restinio::http_header_fields_t::get_field ( http_field_t field_id ) const

inline

Get field by id.

Definition at line 967 of file http_headers.hpp.

◆ get_field_or() [1/8]

std::string restinio::http_header_fields_t::get_field_or	(	string_view_t	field_name,
		string_view_t	default_value
	)		const

inline

Get field value by field name or default value if the field not found.

Note: This method returns field value as a new std::string instance, not a const reference to std::string.

Definition at line 1021 of file http_headers.hpp.

◆ get_field_or() [2/8]

std::string restinio::http_header_fields_t::get_field_or	(	string_view_t	field_name,
		std::string &&	default_value
	)		const

inline

Get field value by field name or default value if the field not found.

Note: This method returns field value as a new std::string instance, not a const reference to std::string.

Definition at line 1040 of file http_headers.hpp.

◆ get_field_or() [3/8]

auto restinio::http_header_fields_t::get_field_or	(	string_view_t	field_name,
		const char *	default_value
	)		const

inline

Get field by name or default value if the field not found.

This is just overload for get_field_or(string_view_t,string_view_t);

Definition at line 1057 of file http_headers.hpp.

◆ get_field_or() [4/8]

auto restinio::http_header_fields_t::get_field_or	(	string_view_t	field_name,
		const std::string &	default_value
	)		const

inline

Get field by name or default value if the field not found.

This is just overload for get_field_or(string_view_t,string_view_t);

Definition at line 1069 of file http_headers.hpp.

◆ get_field_or() [5/8]

std::string restinio::http_header_fields_t::get_field_or	(	http_field_t	field_id,
		string_view_t	default_value
	)		const

inline

Get field by id or default value if the field not found.

Note: This method returns field value as a new std::string instance, not a const reference to std::string.

Definition at line 1083 of file http_headers.hpp.

◆ get_field_or() [6/8]

auto restinio::http_header_fields_t::get_field_or	(	http_field_t	field_id,
		const char *	default_value
	)		const

inline

Get field by id or default value if the field not found.

This is just overload for get_field_or(http_field_t,string_view_t);

Definition at line 1103 of file http_headers.hpp.

◆ get_field_or() [7/8]

auto restinio::http_header_fields_t::get_field_or	(	http_field_t	field_id,
		const std::string &	default_value
	)		const

inline

Get field by id or default value if the field not found.

This is just overload for get_field_or(http_field_t,string_view_t);

Definition at line 1115 of file http_headers.hpp.

◆ get_field_or() [8/8]

std::string restinio::http_header_fields_t::get_field_or	(	http_field_t	field_id,
		std::string &&	default_value
	)		const

inline

Get field by id or default value if the field not found.

Note: This method returns field value as a new std::string instance, not a const reference to std::string.

Definition at line 1129 of file http_headers.hpp.

◆ has_field() [1/2]

bool restinio::http_header_fields_t::has_field ( string_view_t field_name ) const

inlinenoexcept

Check field by name.

Definition at line 794 of file http_headers.hpp.

◆ has_field() [2/2]

bool restinio::http_header_fields_t::has_field ( http_field_t field_id ) const

inlinenoexcept

Check field by field-id.

Note: If field_id=http_field_t::field_unspecified then function returns not more than just a fact whether there is at least one unspecified field.

Definition at line 806 of file http_headers.hpp.

◆ operator=() [1/2]

http_header_fields_t& restinio::http_header_fields_t::operator= ( const http_header_fields_t & )

default

◆ operator=() [2/2]

http_header_fields_t& restinio::http_header_fields_t::operator= ( http_header_fields_t && )

default

◆ opt_value_of() [1/2]

optional_t< string_view_t > restinio::http_header_fields_t::opt_value_of ( string_view_t name ) const

inlinenoexcept

Get optional value of a field.

Doesn't throw exception if the field is not found. Empty optional will be returned instead.

Usage example:

auto f = headers().opt_value_of("Content-Type");
if(f && *f == "text/plain")
    ...

Parameters

name	Name of a field.

Definition at line 1206 of file http_headers.hpp.

◆ opt_value_of() [2/2]

optional_t< string_view_t > restinio::http_header_fields_t::opt_value_of ( http_field_t field_id ) const

inlinenoexcept

Get optional value of a field.

Doesn't throw exception if the field is not found. Empty optional will be returned instead.

Usage example:

auto f = headers().opt_value_of(restinio::http_field::content_type);
if(f && *f == "text/plain")
    ...

Parameters

field_id ID of a field.

Definition at line 1231 of file http_headers.hpp.

◆ remove_field() [1/2]

void restinio::http_header_fields_t::remove_field ( string_view_t field_name )

inline

Remove field by name.

Definition at line 1146 of file http_headers.hpp.

◆ remove_field() [2/2]

void restinio::http_header_fields_t::remove_field ( http_field_t field_id )

inline

Remove field by id.

Definition at line 1158 of file http_headers.hpp.

◆ set_field() [1/3]

void restinio::http_header_fields_t::set_field ( http_header_field_t http_header_field )

inline

Set header field via http_header_field_t.

Definition at line 813 of file http_headers.hpp.

◆ set_field() [2/3]

void restinio::http_header_fields_t::set_field	(	std::string	field_name,
		std::string	field_value
	)

inline

Set field with string pair.

Definition at line 841 of file http_headers.hpp.

◆ set_field() [3/3]

void restinio::http_header_fields_t::set_field	(	http_field_t	field_id,
		std::string	field_value
	)

inline

Set field with id-value pair.

If field_id=http_field_t::field_unspecified then function does nothing.

Definition at line 866 of file http_headers.hpp.

◆ swap_fields()

void restinio::http_header_fields_t::swap_fields ( http_header_fields_t & http_header_fields )

inline

Definition at line 787 of file http_headers.hpp.

◆ try_get_field() [1/2]

nullable_pointer_t<const std::string> restinio::http_header_fields_t::try_get_field ( string_view_t field_name ) const

inlinenoexcept

Try to get the value of a field by field name.

Note: Returns nullptr if the field is not found.

Usage example:

auto f = headers().try_get_field("Content-Type");
if(f && *f == "text/plain")
    ...

Definition at line 956 of file http_headers.hpp.

◆ try_get_field() [2/2]

nullable_pointer_t<const std::string> restinio::http_header_fields_t::try_get_field ( http_field_t field_id ) const

inlinenoexcept

Try to get the value of a field by field ID.

Note: Returns nullptr if the field is not found.

Usage example:

auto f = headers().try_get_field(restinio::http_field::content_type);
if(f && *f == "text/plain")
    ...

Definition at line 1002 of file http_headers.hpp.

◆ value_of() [1/2]

string_view_t restinio::http_header_fields_t::value_of ( string_view_t name ) const

inline

Get the value of a field or throw if the field not found.

Parameters

name	Name of a field.

Definition at line 1177 of file http_headers.hpp.

◆ value_of() [2/2]

string_view_t restinio::http_header_fields_t::value_of ( http_field_t field_id ) const

inline

Get the value of a field or throw if the field not found.

Parameters

field_id ID of a field.

Definition at line 1186 of file http_headers.hpp.

Friends And Related Function Documentation

◆ impl::append_last_field_accessor

void impl::append_last_field_accessor	(	http_header_fields_t &	,
		string_view_t
	)

friend

Member Data Documentation

◆ m_fields

fields_container_t restinio::http_header_fields_t::m_fields

private

Definition at line 1352 of file http_headers.hpp.

The documentation for this class was generated from the following file:

restinio/http_headers.hpp

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ fields_container_t

Constructor & Destructor Documentation

◆ http_header_fields_t() [1/3]

◆ http_header_fields_t() [2/3]

◆ http_header_fields_t() [3/3]

◆ ~http_header_fields_t()

Member Function Documentation

◆ append_field() [1/2]

◆ append_field() [2/2]

◆ append_last_field()

◆ begin()

◆ cfind() [1/2]

◆ cfind() [2/2]

◆ end()

◆ fields_count()

◆ find() [1/2]

◆ find() [2/2]

◆ for_each_field()

◆ get_field() [1/2]

◆ get_field() [2/2]

◆ get_field_or() [1/8]

◆ get_field_or() [2/8]

◆ get_field_or() [3/8]

◆ get_field_or() [4/8]

◆ get_field_or() [5/8]

◆ get_field_or() [6/8]

◆ get_field_or() [7/8]

◆ get_field_or() [8/8]

◆ has_field() [1/2]

◆ has_field() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ opt_value_of() [1/2]

◆ opt_value_of() [2/2]

◆ remove_field() [1/2]

◆ remove_field() [2/2]

◆ set_field() [1/3]

◆ set_field() [2/3]

◆ set_field() [3/3]

◆ swap_fields()

◆ try_get_field() [1/2]

◆ try_get_field() [2/2]

◆ value_of() [1/2]

◆ value_of() [2/2]

Friends And Related Function Documentation

◆ impl::append_last_field_accessor

Member Data Documentation

◆ m_fields