doc/return_stl_iterator.rst

   1 return_stl_iterator
   2 -------------------
   3
   4 Motivation
   5 ~~~~~~~~~~
   6
   7 This policy converts an STL container to a generator function that can be used
   8 in lua to iterate over the container. It works on any container that defines
   9 ``begin()`` and ``end()`` member functions (they have to return iterators).
  10
  11 Defined in
  12 ~~~~~~~~~~
  13
  14 .. parsed-literal::
  15
  16     #include <luabind/iterator_policy.hpp>
  17
  18 Synopsis
  19 ~~~~~~~~
  20
  21 .. parsed-literal::
  22
  23     return_stl_iterator
  24
  25 Example
  26 ~~~~~~~
  27
  28 .. parsed-literal::
  29
  30     struct X
  31     {
  32         std::vector<std::string> names;
  33     };
  34
  35     ...
  36
  37     module(L)
  38     [
  39         class_<A>("A")
  40             .def_readwrite("names", &X::names, **return_stl_iterator**)
  41     ];
  42
  43     ...
  44
  45     > a = A()
  46     > for name in a.names do
  47     >  print(name)
  48     > end
  49