Coverage Report

Created: 2025-10-10 06:33

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/cpython-install/include/python3.15/cpython/bytesobject.h
Line
Count
Source
1
#ifndef Py_CPYTHON_BYTESOBJECT_H
2
#  error "this header file must not be included directly"
3
#endif
4
5
typedef struct {
6
    PyObject_VAR_HEAD
7
    Py_DEPRECATED(3.11) Py_hash_t ob_shash;
8
    char ob_sval[1];
9
10
    /* Invariants:
11
     *     ob_sval contains space for 'ob_size+1' elements.
12
     *     ob_sval[ob_size] == 0.
13
     *     ob_shash is the hash of the byte string or -1 if not computed yet.
14
     */
15
} PyBytesObject;
16
17
PyAPI_FUNC(int) _PyBytes_Resize(PyObject **, Py_ssize_t);
18
19
/* Macros and static inline functions, trading safety for speed */
20
#define _PyBytes_CAST(op) \
21
    (assert(PyBytes_Check(op)), _Py_CAST(PyBytesObject*, op))
22
23
static inline char* PyBytes_AS_STRING(PyObject *op)
24
0
{
25
0
    return _PyBytes_CAST(op)->ob_sval;
26
0
}
27
#define PyBytes_AS_STRING(op) PyBytes_AS_STRING(_PyObject_CAST(op))
28
29
0
static inline Py_ssize_t PyBytes_GET_SIZE(PyObject *op) {
30
0
    PyBytesObject *self = _PyBytes_CAST(op);
31
0
    return Py_SIZE(self);
32
0
}
33
#define PyBytes_GET_SIZE(self) PyBytes_GET_SIZE(_PyObject_CAST(self))
34
35
PyAPI_FUNC(PyObject*) PyBytes_Join(PyObject *sep, PyObject *iterable);
36
37
// Deprecated alias kept for backward compatibility
38
Py_DEPRECATED(3.14) static inline PyObject*
39
_PyBytes_Join(PyObject *sep, PyObject *iterable)
40
0
{
41
0
    return PyBytes_Join(sep, iterable);
42
0
}
43
44
45
// --- PyBytesWriter API -----------------------------------------------------
46
47
typedef struct PyBytesWriter PyBytesWriter;
48
49
PyAPI_FUNC(PyBytesWriter *) PyBytesWriter_Create(
50
    Py_ssize_t size);
51
PyAPI_FUNC(void) PyBytesWriter_Discard(
52
    PyBytesWriter *writer);
53
PyAPI_FUNC(PyObject*) PyBytesWriter_Finish(
54
    PyBytesWriter *writer);
55
PyAPI_FUNC(PyObject*) PyBytesWriter_FinishWithSize(
56
    PyBytesWriter *writer,
57
    Py_ssize_t size);
58
PyAPI_FUNC(PyObject*) PyBytesWriter_FinishWithPointer(
59
    PyBytesWriter *writer,
60
    void *buf);
61
62
PyAPI_FUNC(void*) PyBytesWriter_GetData(
63
    PyBytesWriter *writer);
64
PyAPI_FUNC(Py_ssize_t) PyBytesWriter_GetSize(
65
    PyBytesWriter *writer);
66
67
PyAPI_FUNC(int) PyBytesWriter_WriteBytes(
68
    PyBytesWriter *writer,
69
    const void *bytes,
70
    Py_ssize_t size);
71
PyAPI_FUNC(int) PyBytesWriter_Format(
72
    PyBytesWriter *writer,
73
    const char *format,
74
    ...);
75
76
PyAPI_FUNC(int) PyBytesWriter_Resize(
77
    PyBytesWriter *writer,
78
    Py_ssize_t size);
79
PyAPI_FUNC(int) PyBytesWriter_Grow(
80
    PyBytesWriter *writer,
81
    Py_ssize_t size);
82
PyAPI_FUNC(void*) PyBytesWriter_GrowAndUpdatePointer(
83
    PyBytesWriter *writer,
84
    Py_ssize_t size,
85
    void *buf);