Auto Generated Documentation

This commit is contained in:
github-actions[bot]
2025-04-02 13:41:38 +00:00
parent e9a232e07d
commit 21efed14f2
18523 changed files with 340249 additions and 282417 deletions
@@ -0,0 +1,5 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `PyDict_GetItemRef` fn in crate `pyo3_ffi`."><title>PyDict_GetItemRef in pyo3_ffi::compat - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="pyo3_ffi" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.1 (4eb161250 2025-03-15)" data-channel="1.85.1" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../pyo3_ffi/index.html">pyo3_<wbr>ffi</a><span class="version">0.24.1</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In pyo3_<wbr>ffi::<wbr>compat</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">pyo3_ffi</a>::<wbr><a href="index.html">compat</a></span><h1>Function <span class="fn">PyDict_GetItemRef</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/pyo3_ffi/compat/py_3_13.rs.html#1-23">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe fn PyDict_GetItemRef(
dp: <a class="primitive" href="https://doc.rust-lang.org/1.85.1/std/primitive.pointer.html">*mut </a><a class="struct" href="../struct.PyObject.html" title="struct pyo3_ffi::PyObject">PyObject</a>,
key: <a class="primitive" href="https://doc.rust-lang.org/1.85.1/std/primitive.pointer.html">*mut </a><a class="struct" href="../struct.PyObject.html" title="struct pyo3_ffi::PyObject">PyObject</a>,
result: <a class="primitive" href="https://doc.rust-lang.org/1.85.1/std/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/1.85.1/std/primitive.pointer.html">*mut </a><a class="struct" href="../struct.PyObject.html" title="struct pyo3_ffi::PyObject">PyObject</a>,
) -&gt; <a class="type" href="https://doc.rust-lang.org/1.85.1/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a></code></pre></section></div></main></body></html>
@@ -0,0 +1 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `PyImport_AddModuleRef` fn in crate `pyo3_ffi`."><title>PyImport_AddModuleRef in pyo3_ffi::compat - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="pyo3_ffi" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.1 (4eb161250 2025-03-15)" data-channel="1.85.1" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../pyo3_ffi/index.html">pyo3_<wbr>ffi</a><span class="version">0.24.1</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In pyo3_<wbr>ffi::<wbr>compat</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">pyo3_ffi</a>::<wbr><a href="index.html">compat</a></span><h1>Function <span class="fn">PyImport_AddModuleRef</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/pyo3_ffi/compat/py_3_13.rs.html#41-52">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe fn PyImport_AddModuleRef(name: <a class="primitive" href="https://doc.rust-lang.org/1.85.1/std/primitive.pointer.html">*const </a><a class="type" href="https://doc.rust-lang.org/1.85.1/std/os/raw/type.c_char.html" title="type std::os::raw::c_char">c_char</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.85.1/std/primitive.pointer.html">*mut </a><a class="struct" href="../struct.PyObject.html" title="struct pyo3_ffi::PyObject">PyObject</a></code></pre></section></div></main></body></html>
@@ -0,0 +1 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `PyList_Clear` fn in crate `pyo3_ffi`."><title>PyList_Clear in pyo3_ffi::compat - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="pyo3_ffi" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.1 (4eb161250 2025-03-15)" data-channel="1.85.1" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../pyo3_ffi/index.html">pyo3_<wbr>ffi</a><span class="version">0.24.1</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In pyo3_<wbr>ffi::<wbr>compat</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">pyo3_ffi</a>::<wbr><a href="index.html">compat</a></span><h1>Function <span class="fn">PyList_Clear</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/pyo3_ffi/compat/py_3_13.rs.html#99-106">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe fn PyList_Clear(list: <a class="primitive" href="https://doc.rust-lang.org/1.85.1/std/primitive.pointer.html">*mut </a><a class="struct" href="../struct.PyObject.html" title="struct pyo3_ffi::PyObject">PyObject</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/1.85.1/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a></code></pre></section></div></main></body></html>
@@ -0,0 +1,4 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `PyList_Extend` fn in crate `pyo3_ffi`."><title>PyList_Extend in pyo3_ffi::compat - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="pyo3_ffi" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.1 (4eb161250 2025-03-15)" data-channel="1.85.1" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../pyo3_ffi/index.html">pyo3_<wbr>ffi</a><span class="version">0.24.1</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In pyo3_<wbr>ffi::<wbr>compat</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">pyo3_ffi</a>::<wbr><a href="index.html">compat</a></span><h1>Function <span class="fn">PyList_Extend</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/pyo3_ffi/compat/py_3_13.rs.html#87-97">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe fn PyList_Extend(
list: <a class="primitive" href="https://doc.rust-lang.org/1.85.1/std/primitive.pointer.html">*mut </a><a class="struct" href="../struct.PyObject.html" title="struct pyo3_ffi::PyObject">PyObject</a>,
iterable: <a class="primitive" href="https://doc.rust-lang.org/1.85.1/std/primitive.pointer.html">*mut </a><a class="struct" href="../struct.PyObject.html" title="struct pyo3_ffi::PyObject">PyObject</a>,
) -&gt; <a class="type" href="https://doc.rust-lang.org/1.85.1/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a></code></pre></section></div></main></body></html>
@@ -0,0 +1,4 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `PyList_GetItemRef` fn in crate `pyo3_ffi`."><title>PyList_GetItemRef in pyo3_ffi::compat - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="pyo3_ffi" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.1 (4eb161250 2025-03-15)" data-channel="1.85.1" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../pyo3_ffi/index.html">pyo3_<wbr>ffi</a><span class="version">0.24.1</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In pyo3_<wbr>ffi::<wbr>compat</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">pyo3_ffi</a>::<wbr><a href="index.html">compat</a></span><h1>Function <span class="fn">PyList_GetItemRef</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/pyo3_ffi/compat/py_3_13.rs.html#25-39">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe fn PyList_GetItemRef(
arg1: <a class="primitive" href="https://doc.rust-lang.org/1.85.1/std/primitive.pointer.html">*mut </a><a class="struct" href="../struct.PyObject.html" title="struct pyo3_ffi::PyObject">PyObject</a>,
arg2: <a class="type" href="../type.Py_ssize_t.html" title="type pyo3_ffi::Py_ssize_t">Py_ssize_t</a>,
) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.85.1/std/primitive.pointer.html">*mut </a><a class="struct" href="../struct.PyObject.html" title="struct pyo3_ffi::PyObject">PyObject</a></code></pre></section></div></main></body></html>
@@ -0,0 +1,4 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `PyWeakref_GetRef` fn in crate `pyo3_ffi`."><title>PyWeakref_GetRef in pyo3_ffi::compat - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="pyo3_ffi" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.1 (4eb161250 2025-03-15)" data-channel="1.85.1" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../pyo3_ffi/index.html">pyo3_<wbr>ffi</a><span class="version">0.24.1</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In pyo3_<wbr>ffi::<wbr>compat</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">pyo3_ffi</a>::<wbr><a href="index.html">compat</a></span><h1>Function <span class="fn">PyWeakref_GetRef</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/pyo3_ffi/compat/py_3_13.rs.html#54-85">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe fn PyWeakref_GetRef(
reference: <a class="primitive" href="https://doc.rust-lang.org/1.85.1/std/primitive.pointer.html">*mut </a><a class="struct" href="../struct.PyObject.html" title="struct pyo3_ffi::PyObject">PyObject</a>,
pobj: <a class="primitive" href="https://doc.rust-lang.org/1.85.1/std/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/1.85.1/std/primitive.pointer.html">*mut </a><a class="struct" href="../struct.PyObject.html" title="struct pyo3_ffi::PyObject">PyObject</a>,
) -&gt; <a class="type" href="https://doc.rust-lang.org/1.85.1/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a></code></pre></section></div></main></body></html>
+7
View File
@@ -0,0 +1,7 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="C API Compatibility Shims"><title>pyo3_ffi::compat - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="pyo3_ffi" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.1 (4eb161250 2025-03-15)" data-channel="1.85.1" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../pyo3_ffi/index.html">pyo3_<wbr>ffi</a><span class="version">0.24.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module compat</a></h2><h3><a href="#reexports">Module Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate pyo3_<wbr>ffi</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">pyo3_ffi</a></span><h1>Module <span>compat</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/pyo3_ffi/compat/mod.rs.html#1-59">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>C API Compatibility Shims</p>
<p>Some CPython C API functions added in recent versions of Python are
inherently safer to use than older C API constructs. This module
exposes functions available on all Python versions that wrap the
old C API on old Python versions and wrap the function directly
on newer Python versions.</p>
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.Py_NewRef"><code>pub use $crate::<a class="fn" href="../fn.Py_NewRef.html" title="fn pyo3_ffi::Py_NewRef">Py_NewRef</a>;</code></div></li><li><div class="item-name" id="reexport.Py_XNewRef"><code>pub use $crate::<a class="fn" href="../fn.Py_XNewRef.html" title="fn pyo3_ffi::Py_XNewRef">Py_XNewRef</a>;</code></div></li><li><div class="item-name" id="reexport.PyObject_CallNoArgs"><code>pub use $crate::<a class="fn" href="../fn.PyObject_CallNoArgs.html" title="fn pyo3_ffi::PyObject_CallNoArgs">PyObject_CallNoArgs</a>;</code></div></li><li><div class="item-name" id="reexport.PyObject_CallMethodNoArgs"><code>pub use $crate::<a class="fn" href="../fn.PyObject_CallMethodNoArgs.html" title="fn pyo3_ffi::PyObject_CallMethodNoArgs">PyObject_CallMethodNoArgs</a>;</code></div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.PyDict_GetItemRef.html" title="fn pyo3_ffi::compat::PyDict_GetItemRef">PyDict_<wbr>GetItem<wbr>Ref</a><sup title="unsafe function"></sup></div></li><li><div class="item-name"><a class="fn" href="fn.PyImport_AddModuleRef.html" title="fn pyo3_ffi::compat::PyImport_AddModuleRef">PyImport_<wbr>AddModule<wbr>Ref</a><sup title="unsafe function"></sup></div></li><li><div class="item-name"><a class="fn" href="fn.PyList_Clear.html" title="fn pyo3_ffi::compat::PyList_Clear">PyList_<wbr>Clear</a><sup title="unsafe function"></sup></div></li><li><div class="item-name"><a class="fn" href="fn.PyList_Extend.html" title="fn pyo3_ffi::compat::PyList_Extend">PyList_<wbr>Extend</a><sup title="unsafe function"></sup></div></li><li><div class="item-name"><a class="fn" href="fn.PyList_GetItemRef.html" title="fn pyo3_ffi::compat::PyList_GetItemRef">PyList_<wbr>GetItem<wbr>Ref</a><sup title="unsafe function"></sup></div></li><li><div class="item-name"><a class="fn" href="fn.PyWeakref_GetRef.html" title="fn pyo3_ffi::compat::PyWeakref_GetRef">PyWeakref_<wbr>GetRef</a><sup title="unsafe function"></sup></div></li></ul></section></div></main></body></html>
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../pyo3_ffi/compat/fn.PyDict_GetItemRef.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../pyo3_ffi/compat/fn.PyDict_GetItemRef.html">../../../pyo3_ffi/compat/fn.PyDict_GetItemRef.html</a>...</p>
<script>location.replace("../../../pyo3_ffi/compat/fn.PyDict_GetItemRef.html" + location.search + location.hash);</script>
</body>
</html>
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../pyo3_ffi/compat/fn.PyImport_AddModuleRef.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../pyo3_ffi/compat/fn.PyImport_AddModuleRef.html">../../../pyo3_ffi/compat/fn.PyImport_AddModuleRef.html</a>...</p>
<script>location.replace("../../../pyo3_ffi/compat/fn.PyImport_AddModuleRef.html" + location.search + location.hash);</script>
</body>
</html>
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../pyo3_ffi/compat/fn.PyList_Clear.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../pyo3_ffi/compat/fn.PyList_Clear.html">../../../pyo3_ffi/compat/fn.PyList_Clear.html</a>...</p>
<script>location.replace("../../../pyo3_ffi/compat/fn.PyList_Clear.html" + location.search + location.hash);</script>
</body>
</html>
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../pyo3_ffi/compat/fn.PyList_Extend.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../pyo3_ffi/compat/fn.PyList_Extend.html">../../../pyo3_ffi/compat/fn.PyList_Extend.html</a>...</p>
<script>location.replace("../../../pyo3_ffi/compat/fn.PyList_Extend.html" + location.search + location.hash);</script>
</body>
</html>
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../pyo3_ffi/compat/fn.PyList_GetItemRef.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../pyo3_ffi/compat/fn.PyList_GetItemRef.html">../../../pyo3_ffi/compat/fn.PyList_GetItemRef.html</a>...</p>
<script>location.replace("../../../pyo3_ffi/compat/fn.PyList_GetItemRef.html" + location.search + location.hash);</script>
</body>
</html>
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../pyo3_ffi/compat/fn.PyWeakref_GetRef.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../pyo3_ffi/compat/fn.PyWeakref_GetRef.html">../../../pyo3_ffi/compat/fn.PyWeakref_GetRef.html</a>...</p>
<script>location.replace("../../../pyo3_ffi/compat/fn.PyWeakref_GetRef.html" + location.search + location.hash);</script>
</body>
</html>
+1
View File
@@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"fn":["PyDict_GetItemRef","PyImport_AddModuleRef","PyList_Clear","PyList_Extend","PyList_GetItemRef","PyWeakref_GetRef"]};