ceph/src/Beast/doc/types/Field.qbk

   1 [/
   2     Copyright (c) 2013-2017 Vinnie Falco (vinnie dot falco at gmail dot com)
   3
   4     Distributed under the Boost Software License, Version 1.0. (See accompanying
   5     file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
   6 ]
   7
   8 [section:Field Field requirements]
   9
  10 A [*`Field`] represents a single HTTP header field/value pair.
  11
  12 In this table:
  13
  14 * `X` denotes a type meeting the requirements of [*`Field`].
  15 * `a` denotes a value of type `X`.
  16
  17 [table Field requirements
  18
  19 [[operation][type][semantics, pre/post-conditions]]
  20 [
  21     [`a.name()`]
  22     [`boost::string_ref`]
  23     [
  24         This function returns a value implicitly convertible to
  25         `boost::string_ref` containing the case-insensitive field
  26         name, without leading or trailing white space.
  27     ]
  28 ]
  29 [
  30     [`a.value()`]
  31     [`boost::string_ref`]
  32     [
  33         This function returns a value implicitly convertible to
  34         `boost::string_ref` containing the value for the field. The
  35         value is considered canonical if there is no leading or
  36         trailing whitespace.
  37     ]
  38 ]
  39 ]
  40
  41 [endsect]