ceph/src/Beast/doc/types/FieldSequence.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:FieldSequence FieldSequence requirements]
   9
  10 A [*FieldSequence] is an iterable container whose value type meets
  11 the requirements of [link beast.ref.Field [*Field]]. Objects that meet
  12 these requirements become serializable by the implementation.
  13
  14 In this table:
  15
  16 * `X` denotes a type that meets the requirements of [*FieldSequence].
  17
  18 * `c` is a value of type `X const`.
  19
  20 [table FieldSequence requirements
  21 [[operation][type][semantics, pre/post-conditions]]
  22 [
  23     [`X::value_type`]
  24     []
  25     [
  26         A type that meets the requirements of [link beast.ref.Field [*Field]].
  27     ]
  28 ]
  29 [
  30     [`X::const_iterator`]
  31     []
  32     [
  33         An iterator type whose `reference` type meets the
  34         requirements of [link beast.ref.Field [*Field]], and which
  35         satisfies all the requirements of [*ForwardIterator],
  36         except that:
  37
  38         [ordered_list
  39             [there is no requirement that `operator->` is provided, and]
  40             [there is no requirement that `reference` be a reference type.]
  41         ]
  42     ]
  43 ]
  44 [
  45     [`c.begin()`]
  46     [`X::const_iterator`]
  47     [
  48         Returns an iterator to the beginning of the field sequence.
  49     ]
  50 ]
  51 [
  52     [`c.end()`]
  53     [`X::const_iterator`]
  54     [
  55         Returns an iterator to the end of the field sequence.
  56     ]
  57 ]
  58 ]
  59
  60 [endsect]