doc/dependency.rst

   1 dependency
   2 ----------------
   3
   4 Motivation
   5 ~~~~~~~~~~
   6
   7 The dependency policy is used to create life-time dependencies between values.
   8 This is needed for example when returning internal references to some class.
   9
  10 Defined in
  11 ~~~~~~~~~~
  12
  13 .. parsed-literal::
  14
  15     #include <luabind/dependency_policy.hpp>
  16
  17 Synopsis
  18 ~~~~~~~~
  19
  20 .. parsed-literal::
  21
  22     dependency(nurse_index, patient_index)
  23
  24 Parameters
  25 ~~~~~~~~~~
  26
  27 ================= ==========================================================
  28 Parameter         Purpose
  29 ================= ==========================================================
  30 ``nurse_index``   The index which will keep the patient alive.
  31 ``patient_index`` The index which will be kept alive.
  32 ================= ==========================================================
  33
  34 Example
  35 ~~~~~~~
  36
  37 .. parsed-literal::
  38
  39     struct X
  40     {
  41         B member;
  42         B& get() { return member; }
  43     };
  44
  45     module(L)
  46     [
  47         class_<X>("X")
  48             .def("get", &X::get, **dependency(result, _1)**)
  49     ];
  50