libs/beast/doc/html/beast/ref/boost__beast__http__span_body/value_type.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>http::span_body::value_type</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&#160;1.&#160;Boost.Beast">
   8 <link rel="up" href="../boost__beast__http__span_body.html" title="http::span_body">
   9 <link rel="prev" href="size.html" title="http::span_body::size">
  10 <link rel="next" href="writer.html" title="http::span_body::writer">
  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="size.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__span_body.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="writer.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="beast.ref.boost__beast__http__span_body.value_type"></a><a class="link" href="value_type.html" title="http::span_body::value_type">http::span_body::value_type</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873490345872"></a>
  31 The type of container used for the body.
  32         </p>
  33 <h6>
  34 <a name="beast.ref.boost__beast__http__span_body.value_type.h0"></a>
  35           <span class="phrase"><a name="beast.ref.boost__beast__http__span_body.value_type.synopsis"></a></span><a class="link" href="value_type.html#beast.ref.boost__beast__http__span_body.value_type.synopsis">Synopsis</a>
  36         </h6>
  37 <pre class="programlisting"><span class="keyword">using</span> <span class="identifier">value_type</span> <span class="special">=</span> <span class="identifier">span</span><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;;</span>
  38 </pre>
  39 <h6>
  40 <a name="beast.ref.boost__beast__http__span_body.value_type.h1"></a>
  41           <span class="phrase"><a name="beast.ref.boost__beast__http__span_body.value_type.types"></a></span><a class="link" href="value_type.html#beast.ref.boost__beast__http__span_body.value_type.types">Types</a>
  42         </h6>
  43 <div class="informaltable"><table class="table">
  44 <colgroup>
  45 <col>
  46 <col>
  47 </colgroup>
  48 <thead><tr>
  49 <th>
  50                   <p>
  51                     Name
  52                   </p>
  53                 </th>
  54 <th>
  55                   <p>
  56                     Description
  57                   </p>
  58                 </th>
  59 </tr></thead>
  60 <tbody>
  61 <tr>
  62 <td>
  63                   <p>
  64                     <a class="link" href="../boost__beast__span/const_iterator.html" title="span::const_iterator"><span class="bold"><strong>const_iterator</strong></span></a>
  65                   </p>
  66                 </td>
  67 <td>
  68                   <p>
  69                     The const iterator used by the container.
  70                   </p>
  71                 </td>
  72 </tr>
  73 <tr>
  74 <td>
  75                   <p>
  76                     <a class="link" href="../boost__beast__span/const_pointer.html" title="span::const_pointer"><span class="bold"><strong>const_pointer</strong></span></a>
  77                   </p>
  78                 </td>
  79 <td>
  80                   <p>
  81                     The const pointer used by the container.
  82                   </p>
  83                 </td>
  84 </tr>
  85 <tr>
  86 <td>
  87                   <p>
  88                     <a class="link" href="../boost__beast__span/const_reference.html" title="span::const_reference"><span class="bold"><strong>const_reference</strong></span></a>
  89                   </p>
  90                 </td>
  91 <td>
  92                   <p>
  93                     The const reference used by the container.
  94                   </p>
  95                 </td>
  96 </tr>
  97 <tr>
  98 <td>
  99                   <p>
 100                     <a class="link" href="../boost__beast__span/element_type.html" title="span::element_type"><span class="bold"><strong>element_type</strong></span></a>
 101                   </p>
 102                 </td>
 103 <td>
 104                   <p>
 105                     The type of value, including cv qualifiers.
 106                   </p>
 107                 </td>
 108 </tr>
 109 <tr>
 110 <td>
 111                   <p>
 112                     <a class="link" href="../boost__beast__span/index_type.html" title="span::index_type"><span class="bold"><strong>index_type</strong></span></a>
 113                   </p>
 114                 </td>
 115 <td>
 116                   <p>
 117                     The type of integer used to index the span.
 118                   </p>
 119                 </td>
 120 </tr>
 121 <tr>
 122 <td>
 123                   <p>
 124                     <a class="link" href="../boost__beast__span/iterator.html" title="span::iterator"><span class="bold"><strong>iterator</strong></span></a>
 125                   </p>
 126                 </td>
 127 <td>
 128                   <p>
 129                     The iterator used by the container.
 130                   </p>
 131                 </td>
 132 </tr>
 133 <tr>
 134 <td>
 135                   <p>
 136                     <a class="link" href="../boost__beast__span/pointer.html" title="span::pointer"><span class="bold"><strong>pointer</strong></span></a>
 137                   </p>
 138                 </td>
 139 <td>
 140                   <p>
 141                     A pointer to a span element.
 142                   </p>
 143                 </td>
 144 </tr>
 145 <tr>
 146 <td>
 147                   <p>
 148                     <a class="link" href="../boost__beast__span/reference.html" title="span::reference"><span class="bold"><strong>reference</strong></span></a>
 149                   </p>
 150                 </td>
 151 <td>
 152                   <p>
 153                     A reference to a span element.
 154                   </p>
 155                 </td>
 156 </tr>
 157 <tr>
 158 <td>
 159                   <p>
 160                     <a class="link" href="../boost__beast__span/value_type.html" title="span::value_type"><span class="bold"><strong>value_type</strong></span></a>
 161                   </p>
 162                 </td>
 163 <td>
 164                   <p>
 165                     The type of value of each span element.
 166                   </p>
 167                 </td>
 168 </tr>
 169 </tbody>
 170 </table></div>
 171 <h6>
 172 <a name="beast.ref.boost__beast__http__span_body.value_type.h2"></a>
 173           <span class="phrase"><a name="beast.ref.boost__beast__http__span_body.value_type.member_functions"></a></span><a class="link" href="value_type.html#beast.ref.boost__beast__http__span_body.value_type.member_functions">Member
 174           Functions</a>
 175         </h6>
 176 <div class="informaltable"><table class="table">
 177 <colgroup>
 178 <col>
 179 <col>
 180 </colgroup>
 181 <thead><tr>
 182 <th>
 183                   <p>
 184                     Name
 185                   </p>
 186                 </th>
 187 <th>
 188                   <p>
 189                     Description
 190                   </p>
 191                 </th>
 192 </tr></thead>
 193 <tbody>
 194 <tr>
 195 <td>
 196                   <p>
 197                     <a class="link" href="../boost__beast__span/begin.html" title="span::begin"><span class="bold"><strong>begin</strong></span></a>
 198                   </p>
 199                 </td>
 200 <td>
 201                   <p>
 202                     Returns an iterator to the beginning of the span.
 203                   </p>
 204                 </td>
 205 </tr>
 206 <tr>
 207 <td>
 208                   <p>
 209                     <a class="link" href="../boost__beast__span/cbegin.html" title="span::cbegin"><span class="bold"><strong>cbegin</strong></span></a>
 210                   </p>
 211                 </td>
 212 <td>
 213                   <p>
 214                     Returns an iterator to the beginning of the span.
 215                   </p>
 216                 </td>
 217 </tr>
 218 <tr>
 219 <td>
 220                   <p>
 221                     <a class="link" href="../boost__beast__span/cend.html" title="span::cend"><span class="bold"><strong>cend</strong></span></a>
 222                   </p>
 223                 </td>
 224 <td>
 225                   <p>
 226                     Returns an iterator to one past the end of the span.
 227                   </p>
 228                 </td>
 229 </tr>
 230 <tr>
 231 <td>
 232                   <p>
 233                     <a class="link" href="../boost__beast__span/data.html" title="span::data"><span class="bold"><strong>data</strong></span></a>
 234                   </p>
 235                 </td>
 236 <td>
 237                   <p>
 238                     Returns a pointer to the beginning of the span.
 239                   </p>
 240                 </td>
 241 </tr>
 242 <tr>
 243 <td>
 244                   <p>
 245                     <a class="link" href="../boost__beast__span/empty.html" title="span::empty"><span class="bold"><strong>empty</strong></span></a>
 246                   </p>
 247                 </td>
 248 <td>
 249                   <p>
 250                     Returns true if the span is empty.
 251                   </p>
 252                 </td>
 253 </tr>
 254 <tr>
 255 <td>
 256                   <p>
 257                     <a class="link" href="../boost__beast__span/end.html" title="span::end"><span class="bold"><strong>end</strong></span></a>
 258                   </p>
 259                 </td>
 260 <td>
 261                   <p>
 262                     Returns an iterator to one past the end of the span.
 263                   </p>
 264                 </td>
 265 </tr>
 266 <tr>
 267 <td>
 268                   <p>
 269                     <a class="link" href="../boost__beast__span/operator_eq_.html" title="span::operator="><span class="bold"><strong>operator=</strong></span></a>
 270                   </p>
 271                 </td>
 272 <td>
 273                   <p>
 274                     Assignment.
 275                   </p>
 276                 </td>
 277 </tr>
 278 <tr>
 279 <td>
 280                   <p>
 281                     <a class="link" href="../boost__beast__span/size.html" title="span::size"><span class="bold"><strong>size</strong></span></a>
 282                   </p>
 283                 </td>
 284 <td>
 285                   <p>
 286                     Returns the number of elements in the span.
 287                   </p>
 288                 </td>
 289 </tr>
 290 <tr>
 291 <td>
 292                   <p>
 293                     <a class="link" href="../boost__beast__span/span.html" title="span::span"><span class="bold"><strong>span</strong></span></a>
 294                   </p>
 295                 </td>
 296 <td>
 297                   <p>
 298                     Constructor.
 299                   </p>
 300                 </td>
 301 </tr>
 302 </tbody>
 303 </table></div>
 304 <p>
 305           This class implements a non-owning reference to a storage area of a certain
 306           size and having an underlying integral type with size of 1.
 307         </p>
 308 <h6>
 309 <a name="beast.ref.boost__beast__http__span_body.value_type.h3"></a>
 310           <span class="phrase"><a name="beast.ref.boost__beast__http__span_body.value_type.template_parameters"></a></span><a class="link" href="value_type.html#beast.ref.boost__beast__http__span_body.value_type.template_parameters">Template
 311           Parameters</a>
 312         </h6>
 313 <div class="informaltable"><table class="table">
 314 <colgroup>
 315 <col>
 316 <col>
 317 </colgroup>
 318 <thead><tr>
 319 <th>
 320                   <p>
 321                     Type
 322                   </p>
 323                 </th>
 324 <th>
 325                   <p>
 326                     Description
 327                   </p>
 328                 </th>
 329 </tr></thead>
 330 <tbody><tr>
 331 <td>
 332                   <p>
 333                     <code class="computeroutput"><span class="identifier">T</span></code>
 334                   </p>
 335                 </td>
 336 <td>
 337                   <p>
 338                     The type pointed to by span iterators
 339                   </p>
 340                 </td>
 341 </tr></tbody>
 342 </table></div>
 343 <h6>
 344 <a name="beast.ref.boost__beast__http__span_body.value_type.h4"></a>
 345           <span class="phrase"><a name="beast.ref.boost__beast__http__span_body.value_type.description"></a></span><a class="link" href="value_type.html#beast.ref.boost__beast__http__span_body.value_type.description">Description</a>
 346         </h6>
 347 <p>
 348           This determines the type of <a class="link" href="../boost__beast__http__message/body.html" title="http::message::body"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">message</span><span class="special">::</span><span class="identifier">body</span></code></a> when this body type is used
 349           with a message container.
 350         </p>
 351 </div>
 352 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 353 <td align="left"></td>
 354 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 355       Falco<p>
 356         Distributed under the Boost Software License, Version 1.0. (See accompanying
 357         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>)
 358       </p>
 359 </div></td>
 360 </tr></table>
 361 <hr>
 362 <div class="spirit-nav">
 363 <a accesskey="p" href="size.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__span_body.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="writer.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 364 </div>
 365 </body>
 366 </html>