doc/adopt.rst

   1 adopt
   2 ----------------
   3
   4 Motivation
   5 ~~~~~~~~~~
   6
   7 Used to transfer ownership across language boundaries.
   8
   9 Defined in
  10 ~~~~~~~~~~
  11
  12 .. parsed-literal::
  13
  14     #include <luabind/adopt_policy.hpp>
  15
  16 Synopsis
  17 ~~~~~~~~
  18
  19 .. parsed-literal::
  20
  21     adopt(index)
  22
  23 Parameters
  24 ~~~~~~~~~~
  25
  26 ============= ===============================================================
  27 Parameter     Purpose
  28 ============= ===============================================================
  29 ``index``     The index which should transfer ownership, ``_N`` or ``result``
  30 ============= ===============================================================
  31
  32 Example
  33 ~~~~~~~
  34
  35 .. parsed-literal::
  36
  37     X* create()
  38     {
  39         return new X;
  40     }
  41
  42     ...
  43
  44     module(L)
  45     [
  46         def("create", &create, **adopt(result)**)
  47     ];
  48