boost::beast::http::token_list Class Reference

#include <rfc7230.hpp>

Classes
class	const_iterator

Public Types
using	value_type = string_view
	The type of each element in the token list. More...

Public Member Functions
	token_list (string_view s)
const_iterator	begin () const
	Return a const iterator to the beginning of the list. More...
const_iterator	end () const
	Return a const iterator to the end of the list. More...
const_iterator	cbegin () const
	Return a const iterator to the beginning of the list. More...
const_iterator	cend () const
	Return a const iterator to the end of the list. More...
template<class T >
bool	exists (T const &s)

Detailed Description

A list of tokens in a comma separated HTTP field value.

This container allows iteration of a list of items in a header field value. The input is a comma separated list of tokens.

If a parsing error is encountered while iterating the string, the behavior of the container will be as if a string containing only characters up to but excluding the first invalid character was used to construct the list.

BNF

token-list  = *( "," OWS ) token *( OWS "," [ OWS token ] )

To use this class, construct with the string to be parsed and then use begin and end, or range-for to iterate each item:

Example

for(auto const& token : token_list{"apple, pear, banana"})
    std::cout << token << "\n";

Member Typedef Documentation

using boost::beast::http::token_list::value_type = string_view

The type of each element in the token list.

Constructor & Destructor Documentation

boost::beast::http::token_list::token_list ( string_view  s )

inlineexplicit

Construct a list.

Parameters

s	A string containing the list contents. The string must remain valid for the lifetime of the container.

Member Function Documentation

auto boost::beast::http::token_list::begin ( ) const

inline

Return a const iterator to the beginning of the list.

auto boost::beast::http::token_list::cbegin ( ) const

inline

Return a const iterator to the beginning of the list.

auto boost::beast::http::token_list::cend ( ) const

inline

Return a const iterator to the end of the list.

auto boost::beast::http::token_list::end ( ) const

inline

Return a const iterator to the end of the list.

template<class T >

bool boost::beast::http::token_list::exists

(

T const &

s

)

Return true if a token is present in the list.

Parameters

s	The token to find. A case-insensitive comparison is used.

---

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

• 3pp/beast/boost/beast/http/rfc7230.hpp
• 3pp/beast/boost/beast/http/impl/rfc7230.ipp