Author: Armin Rigo <ar...@tunes.org>
Branch:
Changeset: r942:7aaba88f07dd
Date: 2012-09-18 17:03 +0200
http://bitbucket.org/cffi/cffi/changeset/7aaba88f07dd/
Log: Document ffi.addressof().
diff --git a/doc/source/index.rst b/doc/source/index.rst
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -642,8 +642,11 @@
now it returns a regular ``<cdata 'type *' NULL>``, which you can
check for e.g. by comparing it with ``ffi.NULL``.
-There is no equivalent to the ``&`` operator in C (because it would not
-fit nicely in the model, and it does not seem to be needed here).
+There is no general equivalent to the ``&`` operator in C (because it
+would not fit nicely in the model, and it does not seem to be needed
+here). But see ``ffi.addressof()`` below__.
+
+__ Miscellaneous_
Any operation that would in C return a pointer or array or struct type
gives you a fresh cdata object. Unlike the "original" one, these fresh
@@ -1031,6 +1034,15 @@
.. "versionadded:: 0.3" --- inlined in the previous paragraph
+``ffi.addressof(cdata)``: from a cdata whose type is ``struct foo_s``,
+return its "address", as a cdata whose type is ``struct foo_s *``. Also
+works on unions, but not on any other type. (It would be difficult
+because only structs and unions are internally stored as an indirect
+pointer to the data.) The returned pointer is only valid as long as
+the original object is. *New in version 0.4.*
+
+.. "versionadded:: 0.4" --- inlined in the previous paragraph
+
Unimplemented features
----------------------
_______________________________________________
pypy-commit mailing list
pypy-commit@python.org
http://mail.python.org/mailman/listinfo/pypy-commit
