summaryrefslogtreecommitdiff
path: root/Cython/Includes/cpython/marshal.pxd
blob: 1d8a54c86a00b5297f21acc0b9e1b3012565878e (plain)
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
from libc.stdio cimport FILE

cdef extern from "Python.h":

    ###########################################################################
    # Data marshalling support
    ###########################################################################

    const int Py_MARSHAL_VERSION

    void PyMarshal_WriteLongToFile(long value, FILE *file, int version)
    # Marshal a long integer, value, to file. This will only write the
    # least-significant 32 bits of value, regardless of the size of the native
    # long type. version indicates the file format.

    void PyMarshal_WriteObjectToFile(object value, FILE *file, int version)
    # Marshal a Python object, value, to file. version indicates the file
    # format.

    bytes PyMarshal_WriteObjectToString(object value, int version)
    # Return value: New reference.
    # Return a bytes object containing the marshalled representation of value.
    # version indicates the file format.

    long PyMarshal_ReadLongFromFile(FILE *file) except? -1
    # Return a C long from the data stream in a FILE* opened for reading. Only
    # a 32-bit value can be read in using this function, regardless of the
    # native size of long.

    # On error, sets the appropriate exception (EOFError) and returns -1.

    int PyMarshal_ReadShortFromFile(FILE *file) except? -1
    # Return a C short from the data stream in a FILE* opened for reading. Only
    # a 16-bit value can be read in using this function, regardless of the
    # native size of short.

    # On error, sets the appropriate exception (EOFError) and returns -1.

    object PyMarshal_ReadObjectFromFile(FILE *file)
    # Return value: New reference.
    # Return a Python object from the data stream in a FILE* opened for
    # reading.

    # On error, sets the appropriate exception (EOFError, ValueError or
    # TypeError) and returns NULL.

    object PyMarshal_ReadLastObjectFromFile(FILE *file)
    # Return value: New reference.
    # Return a Python object from the data stream in a FILE* opened for
    # reading. Unlike PyMarshal_ReadObjectFromFile(), this function assumes
    # that no further objects will be read from the file, allowing it to
    # aggressively load file data into memory so that the de-serialization can
    # operate from data in memory, rather than reading a byte at a time from the
    # file. Only use these variant if you are certain that you won’t be reading
    # anything else from the file.

    # On error, sets the appropriate exception (EOFError, ValueError or
    # TypeError) and returns NULL.

    object PyMarshal_ReadObjectFromString(const char *data, Py_ssize_t len)
    # Return value: New reference.
    # Return a Python object from the data stream in a byte buffer containing
    # len bytes pointed to by data.

    # On error, sets the appropriate exception (EOFError, ValueError or
    # TypeError) and returns NULL.