Skip to main content

pyo3_ffi/
longobject.rs

1use crate::object::*;
2use crate::pyport::Py_ssize_t;
3#[cfg(any(all(Py_3_14, not(Py_LIMITED_API)), Py_3_15))]
4use crate::Py_uintptr_t;
5use core::ffi::{c_char, c_double, c_int, c_long, c_longlong, c_ulong, c_ulonglong, c_void};
6use libc::size_t;
7
8opaque_struct!(pub PyLongObject);
9
10#[inline]
11#[cfg(not(RustPython))]
12pub unsafe fn PyLong_Check(op: *mut PyObject) -> c_int {
13    PyType_FastSubclass(Py_TYPE(op), Py_TPFLAGS_LONG_SUBCLASS)
14}
15
16#[inline]
17#[cfg(not(RustPython))]
18pub unsafe fn PyLong_CheckExact(op: *mut PyObject) -> c_int {
19    Py_IS_TYPE(op, &raw mut PyLong_Type)
20}
21
22extern_libpython! {
23    #[cfg(RustPython)]
24    pub fn PyLong_Check(op: *mut PyObject) -> c_int;
25    #[cfg(RustPython)]
26    pub fn PyLong_CheckExact(op: *mut PyObject) -> c_int;
27
28    #[cfg_attr(PyPy, link_name = "PyPyLong_FromLong")]
29    pub fn PyLong_FromLong(arg1: c_long) -> *mut PyObject;
30    #[cfg_attr(PyPy, link_name = "PyPyLong_FromUnsignedLong")]
31    pub fn PyLong_FromUnsignedLong(arg1: c_ulong) -> *mut PyObject;
32    #[cfg_attr(PyPy, link_name = "PyPyLong_FromSize_t")]
33    pub fn PyLong_FromSize_t(arg1: size_t) -> *mut PyObject;
34    #[cfg_attr(PyPy, link_name = "PyPyLong_FromSsize_t")]
35    pub fn PyLong_FromSsize_t(arg1: Py_ssize_t) -> *mut PyObject;
36    #[cfg_attr(PyPy, link_name = "PyPyLong_FromDouble")]
37    pub fn PyLong_FromDouble(arg1: c_double) -> *mut PyObject;
38    #[cfg_attr(PyPy, link_name = "PyPyLong_AsLong")]
39    pub fn PyLong_AsLong(arg1: *mut PyObject) -> c_long;
40    #[cfg_attr(PyPy, link_name = "PyPyLong_AsLongAndOverflow")]
41    pub fn PyLong_AsLongAndOverflow(arg1: *mut PyObject, arg2: *mut c_int) -> c_long;
42    #[cfg_attr(PyPy, link_name = "PyPyLong_AsSsize_t")]
43    pub fn PyLong_AsSsize_t(arg1: *mut PyObject) -> Py_ssize_t;
44    #[cfg_attr(PyPy, link_name = "PyPyLong_AsSize_t")]
45    pub fn PyLong_AsSize_t(arg1: *mut PyObject) -> size_t;
46    #[cfg_attr(PyPy, link_name = "PyPyLong_AsUnsignedLong")]
47    pub fn PyLong_AsUnsignedLong(arg1: *mut PyObject) -> c_ulong;
48    #[cfg_attr(PyPy, link_name = "PyPyLong_AsUnsignedLongMask")]
49    pub fn PyLong_AsUnsignedLongMask(arg1: *mut PyObject) -> c_ulong;
50
51    // skipped non-limited PyLong_AsInt
52
53    #[cfg(Py_3_14)]
54    pub fn PyLong_FromInt32(arg1: i32) -> *mut PyObject;
55    #[cfg(Py_3_14)]
56    pub fn PyLong_FromUInt32(arg1: u32) -> *mut PyObject;
57    #[cfg(Py_3_14)]
58    pub fn PyLong_FromInt64(arg1: i64) -> *mut PyObject;
59    #[cfg(Py_3_14)]
60    pub fn PyLong_FromUInt64(arg1: u64) -> *mut PyObject;
61
62    #[cfg(Py_3_14)]
63    pub fn PyLong_AsInt32(arg1: *mut PyObject, arg2: *mut i32) -> c_int;
64    #[cfg(Py_3_14)]
65    pub fn PyLong_AsUInt32(arg1: *mut PyObject, arg2: *mut u32) -> c_int;
66    #[cfg(Py_3_14)]
67    pub fn PyLong_AsInt64(arg1: *mut PyObject, arg2: *mut i64) -> c_int;
68    #[cfg(Py_3_14)]
69    pub fn PyLong_AsUInt64(arg1: *mut PyObject, arg2: *mut u64) -> c_int;
70}
71
72#[cfg(any(Py_3_14, all(Py_3_13, not(Py_LIMITED_API))))]
73pub const Py_ASNATIVEBYTES_DEFAULTS: c_int = -1;
74#[cfg(any(Py_3_14, all(Py_3_13, not(Py_LIMITED_API))))]
75pub const Py_ASNATIVEBYTES_BIG_ENDIAN: c_int = 0;
76#[cfg(any(Py_3_14, all(Py_3_13, not(Py_LIMITED_API))))]
77pub const Py_ASNATIVEBYTES_LITTLE_ENDIAN: c_int = 1;
78#[cfg(any(Py_3_14, all(Py_3_13, not(Py_LIMITED_API))))]
79pub const Py_ASNATIVEBYTES_NATIVE_ENDIAN: c_int = 3;
80#[cfg(any(Py_3_14, all(Py_3_13, not(Py_LIMITED_API))))]
81pub const Py_ASNATIVEBYTES_UNSIGNED_BUFFER: c_int = 4;
82#[cfg(any(Py_3_14, all(Py_3_13, not(Py_LIMITED_API))))]
83pub const Py_ASNATIVEBYTES_REJECT_NEGATIVE: c_int = 8;
84#[cfg(any(Py_3_14, all(Py_3_13, not(Py_LIMITED_API))))]
85pub const Py_ASNATIVEBYTES_ALLOW_INDEX: c_int = 16;
86
87extern_libpython! {
88    #[cfg(any(Py_3_14, all(Py_3_13, not(Py_LIMITED_API))))]
89    pub fn PyLong_AsNativeBytes(
90        v: *mut PyObject,
91        buffer: *mut c_void,
92        n_bytes: Py_ssize_t,
93        flags: c_int,
94    ) -> Py_ssize_t;
95
96    #[cfg(any(Py_3_14, all(Py_3_13, not(Py_LIMITED_API))))]
97    pub fn PyLong_FromNativeBytes(
98        buffer: *const c_void,
99        n_bytes: size_t,
100        flags: c_int,
101    ) -> *mut PyObject;
102
103    #[cfg(any(Py_3_14, all(Py_3_13, not(Py_LIMITED_API))))]
104    pub fn PyLong_FromUnsignedNativeBytes(
105        buffer: *const c_void,
106        n_bytes: size_t,
107        flags: c_int,
108    ) -> *mut PyObject;
109
110    pub fn PyLong_GetInfo() -> *mut PyObject;
111    // skipped PyLong_AS_LONG
112
113    // skipped PyLong_FromPid
114    // skipped PyLong_AsPid
115    // skipped _Py_PARSE_INTPTR
116    // skipped _Py_PARSE_UINTPTR
117
118    #[cfg_attr(PyPy, link_name = "PyPyLong_AsDouble")]
119    pub fn PyLong_AsDouble(arg1: *mut PyObject) -> c_double;
120    #[cfg_attr(PyPy, link_name = "PyPyLong_FromVoidPtr")]
121    pub fn PyLong_FromVoidPtr(arg1: *mut c_void) -> *mut PyObject;
122    #[cfg_attr(PyPy, link_name = "PyPyLong_AsVoidPtr")]
123    pub fn PyLong_AsVoidPtr(arg1: *mut PyObject) -> *mut c_void;
124    #[cfg_attr(PyPy, link_name = "PyPyLong_FromLongLong")]
125    pub fn PyLong_FromLongLong(arg1: c_longlong) -> *mut PyObject;
126    #[cfg_attr(PyPy, link_name = "PyPyLong_FromUnsignedLongLong")]
127    pub fn PyLong_FromUnsignedLongLong(arg1: c_ulonglong) -> *mut PyObject;
128    #[cfg_attr(PyPy, link_name = "PyPyLong_AsLongLong")]
129    pub fn PyLong_AsLongLong(arg1: *mut PyObject) -> c_longlong;
130    #[cfg_attr(PyPy, link_name = "PyPyLong_AsUnsignedLongLong")]
131    pub fn PyLong_AsUnsignedLongLong(arg1: *mut PyObject) -> c_ulonglong;
132    #[cfg_attr(PyPy, link_name = "PyPyLong_AsUnsignedLongLongMask")]
133    pub fn PyLong_AsUnsignedLongLongMask(arg1: *mut PyObject) -> c_ulonglong;
134    #[cfg_attr(PyPy, link_name = "PyPyLong_AsLongLongAndOverflow")]
135    pub fn PyLong_AsLongLongAndOverflow(arg1: *mut PyObject, arg2: *mut c_int) -> c_longlong;
136    #[cfg_attr(PyPy, link_name = "PyPyLong_FromString")]
137    pub fn PyLong_FromString(
138        arg1: *const c_char,
139        arg2: *mut *mut c_char,
140        arg3: c_int,
141    ) -> *mut PyObject;
142}
143
144extern_libpython! {
145    pub fn PyOS_strtoul(arg1: *const c_char, arg2: *mut *mut c_char, arg3: c_int) -> c_ulong;
146    pub fn PyOS_strtol(arg1: *const c_char, arg2: *mut *mut c_char, arg3: c_int) -> c_long;
147}
148
149#[cfg(any(all(Py_3_14, not(Py_LIMITED_API)), Py_3_15))]
150#[derive(Copy, Clone)]
151#[repr(C)]
152pub struct PyLongLayout {
153    pub bits_per_digit: u8,
154    pub digit_size: u8,
155    pub digits_order: i8,
156    pub digit_endianness: i8,
157}
158
159#[cfg(any(all(Py_3_14, not(Py_LIMITED_API)), Py_3_15))]
160extern_libpython! {
161    pub fn PyLong_GetNativeLayout() -> *const PyLongLayout;
162}
163
164#[cfg(any(all(Py_3_14, not(Py_LIMITED_API)), Py_3_15))]
165#[repr(C)]
166pub struct PyLongExport {
167    pub value: i64,
168    pub negative: u8,
169    pub ndigits: Py_ssize_t,
170    pub digits: *const c_void,
171    _reserved: Py_uintptr_t,
172}
173
174#[cfg(any(all(Py_3_14, not(Py_LIMITED_API)), Py_3_15))]
175extern_libpython! {
176    pub fn PyLong_Export(obj: *mut PyObject, export_long: *mut PyLongExport) -> c_int;
177    pub fn PyLong_FreeExport(export_long: *mut PyLongExport);
178}
179
180#[cfg(any(all(Py_3_14, not(Py_LIMITED_API)), Py_3_15))]
181opaque_struct!(pub PyLongWriter);
182
183#[cfg(any(all(Py_3_14, not(Py_LIMITED_API)), Py_3_15))]
184extern_libpython! {
185    pub fn PyLongWriter_Create(
186        negative: c_int,
187        ndigits: Py_ssize_t,
188        digits: *mut *mut c_void,
189    ) -> *mut PyLongWriter;
190
191    pub fn PyLongWriter_Finish(writer: *mut PyLongWriter) -> *mut PyObject;
192
193    pub fn PyLongWriter_Discard(writer: *mut PyLongWriter);
194}
⚠️ Internal Docs ⚠️ Not Public API 👉 Official Docs Here