• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>http::opt_token_list</title>
5<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="../../index.html" title="Chapter 1. Boost.Beast">
8<link rel="up" href="../ref.html" title="This Page Intentionally Left Blank 2/2">
9<link rel="prev" href="boost__beast__http__response_parser.html" title="http::response_parser">
10<link rel="next" href="boost__beast__http__request_serializer.html" title="http::request_serializer">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%"><tr>
14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
15<td align="center"><a href="../../../../../../index.html">Home</a></td>
16<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
20</tr></table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="boost__beast__http__response_parser.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__http__request_serializer.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h4 class="title">
27<a name="beast.ref.boost__beast__http__opt_token_list"></a><a class="link" href="boost__beast__http__opt_token_list.html" title="http::opt_token_list">http::opt_token_list</a>
28</h4></div></div></div>
29<p>
30        <a class="indexterm" name="idm46057507939424"></a>
31      </p>
32<p>
33        A list of tokens in a comma separated HTTP field value.
34      </p>
35<h5>
36<a name="beast.ref.boost__beast__http__opt_token_list.h0"></a>
37        <span class="phrase"><a name="beast.ref.boost__beast__http__opt_token_list.synopsis"></a></span><a class="link" href="boost__beast__http__opt_token_list.html#beast.ref.boost__beast__http__opt_token_list.synopsis">Synopsis</a>
38      </h5>
39<p>
40        Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/http/rfc7230.hpp" target="_top">boost/beast/http/rfc7230.hpp</a>&gt;</code>
41      </p>
42<pre class="programlisting"><span class="keyword">using</span> <span class="identifier">opt_token_list</span> <span class="special">=</span> <span class="identifier">detail</span><span class="special">::</span><span class="identifier">basic_parsed_list</span><span class="special">&lt;</span> <span class="identifier">detail</span><span class="special">::</span><span class="identifier">opt_token_list_policy</span> <span class="special">&gt;;</span>
43</pre>
44<h5>
45<a name="beast.ref.boost__beast__http__opt_token_list.h1"></a>
46        <span class="phrase"><a name="beast.ref.boost__beast__http__opt_token_list.description"></a></span><a class="link" href="boost__beast__http__opt_token_list.html#beast.ref.boost__beast__http__opt_token_list.description">Description</a>
47      </h5>
48<p>
49        This container allows iteration of a list of items in a header field value.
50        The input is a comma separated list of tokens. If a parsing error is encountered
51        while iterating the string, the behavior of the container will be as if a
52        string containing only characters up to but excluding the first invalid character
53        was used to construct the list.
54      </p>
55<h5>
56<a name="beast.ref.boost__beast__http__opt_token_list.h2"></a>
57        <span class="phrase"><a name="beast.ref.boost__beast__http__opt_token_list.bnf"></a></span><a class="link" href="boost__beast__http__opt_token_list.html#beast.ref.boost__beast__http__opt_token_list.bnf">BNF</a>
58      </h5>
59<pre class="programlisting"><span class="identifier">token</span><span class="special">-</span><span class="identifier">list</span>  <span class="special">=</span> <span class="special">*(</span> <span class="string">","</span> <span class="identifier">OWS</span> <span class="special">)</span> <span class="identifier">token</span> <span class="special">*(</span> <span class="identifier">OWS</span> <span class="string">","</span> <span class="special">[</span> <span class="identifier">OWS</span> <span class="identifier">token</span> <span class="special">]</span> <span class="special">)</span>
60</pre>
61<p>
62        To use this class, construct with the string to be parsed and then use <code class="computeroutput"><span class="identifier">begin</span></code> and <code class="computeroutput"><span class="identifier">end</span></code>,
63        or range-for to iterate each item:
64      </p>
65<h5>
66<a name="beast.ref.boost__beast__http__opt_token_list.h3"></a>
67        <span class="phrase"><a name="beast.ref.boost__beast__http__opt_token_list.example"></a></span><a class="link" href="boost__beast__http__opt_token_list.html#beast.ref.boost__beast__http__opt_token_list.example">Example</a>
68      </h5>
69<pre class="programlisting"><span class="keyword">for</span><span class="special">(</span><span class="keyword">auto</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">token</span> <span class="special">:</span> <span class="identifier">token_list</span><span class="special">{</span><span class="string">"apple, pear, banana"</span><span class="special">})</span>
70    <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">token</span> <span class="special">&lt;&lt;</span> <span class="string">"\n"</span><span class="special">;</span>
71</pre>
72</div>
73<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
74<td align="left"></td>
75<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
76      Falco<p>
77        Distributed under the Boost Software License, Version 1.0. (See accompanying
78        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
79      </p>
80</div></td>
81</tr></table>
82<hr>
83<div class="spirit-nav">
84<a accesskey="p" href="boost__beast__http__response_parser.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__http__request_serializer.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
85</div>
86</body>
87</html>
88