Browse Source

docs/reference/speed_python: Update that read-only buffers are accepted.

As allowed by recent cd35dd9d9a
pull/5020/head
Peter Hinch 5 years ago
committed by Damien George
parent
commit
3a679eaf00
  1. 8
      docs/reference/speed_python.rst

8
docs/reference/speed_python.rst

@ -293,9 +293,11 @@ microseconds. The rules for casting are as follows:
* The argument to a bool cast must be integral type (boolean or integer); when used as a return
type the viper function will return True or False objects.
* If the argument is a Python object and the cast is ``ptr``, ``ptr``, ``ptr16`` or ``ptr32``,
then the Python object must either have the buffer protocol with read-write capabilities
(in which case a pointer to the start of the buffer is returned) or it must be of integral
type (in which case the value of that integral object is returned).
then the Python object must either have the buffer protocol (in which case a pointer to the
start of the buffer is returned) or it must be of integral type (in which case the value of
that integral object is returned).
Writing to a pointer which points to a read-only object will lead to undefined behaviour.
The following example illustrates the use of a ``ptr16`` cast to toggle pin X1 ``n`` times:

Loading…
Cancel
Save