File: to_python_value.qbk

package info (click to toggle)
boost1.83 1.83.0-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 545,632 kB
  • sloc: cpp: 3,857,086; xml: 125,552; ansic: 34,414; python: 25,887; asm: 5,276; sh: 4,799; ada: 1,681; makefile: 1,629; perl: 1,212; pascal: 1,139; sql: 810; yacc: 478; ruby: 102; lisp: 24; csh: 6
file content (34 lines) | stat: -rw-r--r-- 1,004 bytes parent folder | download | duplicates (10)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
[section boost/python/to_python_value.hpp]
[section Introduction]
`to_python_value` is a model of [link concepts.resultconverter ResultConverter] which copies its argument into a new Python object.
[endsect]
[section Class template `to_python_value`]
``
namespace boost { namespace python
{
   template <class T>
   struct to_python_value
   {
      typedef typename add_reference<
         typename add_const<T>::type
      >::type argument_type;

      static bool convertible();
      PyObject* operator()(argument_type) const;
   };
}}
``
[endsect]
[section Class `to_python_value` observers]
``static bool convertible();``
[variablelist
[[Returns][`true` iff a converter has been registered which can convert `T` to python by-value. ]]
]
``PyObject* operator()(argument_type x) const;``
[variablelist
[[Requires][`convertible() == true`]]
[[Effects][converts `x` to python]]
[[Returns][the resulting Python object iff a converter for `T` has been registered, `0` otherwise. ]]
]
[endsect]
[endsect]