boost::beast::http::basic_chunk_extensions< Allocator > Class Template Reference

#include <chunk_encode.hpp>

Classes
class	const_iterator

Public Types
using	value_type = std::pair< string_view, string_view >

Public Member Functions
	basic_chunk_extensions ()=default
	Constructor. More...
	basic_chunk_extensions (basic_chunk_extensions &&)=default
	Constructor. More...
	basic_chunk_extensions (basic_chunk_extensions const &)=default
	Constructor. More...
	basic_chunk_extensions (Allocator const &allocator)
void	clear ()
void	parse (string_view s, error_code &ec)
void	insert (string_view name)
void	insert (string_view name, string_view value)
string_view	str () const
	Return the serialized representation of the chunk extension. More...
const_iterator	begin () const
const_iterator	end () const

Detailed Description

template<class Allocator>
class boost::beast::http::basic_chunk_extensions< Allocator >

A set of chunk extensions

This container stores a set of chunk extensions suited for use with chunk_header and chunk_body. The container may be iterated to access the extensions in their structured form.

Meets the requirements of ChunkExtensions

Member Typedef Documentation

template<class Allocator >

using boost::beast::http::basic_chunk_extensions< Allocator >::value_type = std::pair<string_view, string_view>

The type of value when iterating.

The first element of the pair is the name, and the second element is the value which may be empty. The value is stored in its raw representation, without quotes or escapes.

Constructor & Destructor Documentation

template<class Allocator >

boost::beast::http::basic_chunk_extensions< Allocator >::basic_chunk_extensions ( )

default

Constructor.

template<class Allocator >

boost::beast::http::basic_chunk_extensions< Allocator >::basic_chunk_extensions ( basic_chunk_extensions< Allocator > &&  )

default

Constructor.

template<class Allocator >

boost::beast::http::basic_chunk_extensions< Allocator >::basic_chunk_extensions ( basic_chunk_extensions< Allocator > const &  )

default

Constructor.

template<class Allocator >

boost::beast::http::basic_chunk_extensions< Allocator >::basic_chunk_extensions ( Allocator const &  allocator )

inlineexplicit

Constructor

Parameters

allocator

The allocator to use for storing the serialized extension

Member Function Documentation

template<class Allocator >

auto boost::beast::http::basic_chunk_extensions< Allocator >::begin ( ) const

inline

template<class Allocator >

void boost::beast::http::basic_chunk_extensions< Allocator >::clear ( )

inline

Clear the chunk extensions

This preserves the capacity of the internal string used to hold the serialized representation.

template<class Allocator >

auto boost::beast::http::basic_chunk_extensions< Allocator >::end ( ) const

inline

template<class Allocator >

void boost::beast::http::basic_chunk_extensions< Allocator >::insert

(

string_view

name

)

Insert an extension name with an empty value

Parameters

name	The name of the extension

template<class Allocator >

void boost::beast::http::basic_chunk_extensions< Allocator >::insert	(	string_view	name,
		string_view	value
	)

Insert an extension value

Parameters

name	The name of the extension
value	The value to insert. Depending on the contents, the serialized extension may use a quoted string.

template<class Allocator >

void boost::beast::http::basic_chunk_extensions< Allocator >::parse	(	string_view	s,
		error_code &	ec
	)

Parse a set of chunk extensions

Any previous extensions will be cleared

template<class Allocator >

string_view boost::beast::http::basic_chunk_extensions< Allocator >::str ( ) const

inline

Return the serialized representation of the chunk extension.

---

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

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