Skip to content

gh-146353: Document PyBytesWriter_GetData pointer validity #151418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
harjothkhara wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −2
Open

gh-146353: Document PyBytesWriter_GetData pointer validity #151418

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions Doc/c-api/bytes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,14 +384,18 @@ Getters

Get the writer size.

The function does not invalidate pointers returned by
:c:func:`PyBytesWriter_GetData`.

The function cannot fail.

.. c:function:: void* PyBytesWriter_GetData(PyBytesWriter *writer)

Get the writer data: start of the internal buffer.

The pointer is valid until :c:func:`PyBytesWriter_Finish` or
:c:func:`PyBytesWriter_Discard` is called on *writer*.
The pointer remains valid until a :c:type:`PyBytesWriter` function other
than :c:func:`PyBytesWriter_GetData` or :c:func:`PyBytesWriter_GetSize` is
called on *writer*.

The function cannot fail.

Expand Down
Loading