github-actions[bot]
42 lines
22 KiB
HTML
42 lines
22 KiB
HTML
<!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="Raw level conversion between `*mut ffi::PyObject` and PyO3 types."><meta name="keywords" content="rust, rustlang, rust-lang, FromPyPointer"><title>pyo3::conversion::FromPyPointer - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../../pyo3/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Trait FromPyPointer</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.from_owned_ptr_or_opt">from_owned_ptr_or_opt</a><a href="#tymethod.from_borrowed_ptr_or_opt">from_borrowed_ptr_or_opt</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.from_owned_ptr">from_owned_ptr</a><a href="#method.from_borrowed_ptr">from_borrowed_ptr</a><a href="#method.from_owned_ptr_or_panic">from_owned_ptr_or_panic</a><a href="#method.from_owned_ptr_or_err">from_owned_ptr_or_err</a><a href="#method.from_borrowed_ptr_or_panic">from_borrowed_ptr_or_panic</a><a href="#method.from_borrowed_ptr_or_err">from_borrowed_ptr_or_err</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../index.html">pyo3</a>::<wbr><a href="index.html">conversion</a></p><div id="sidebar-vars" data-name="FromPyPointer" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="../index.html">pyo3</a>::<wbr><a href="index.html">conversion</a>::<wbr><a class="trait" href="">FromPyPointer</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/pyo3/conversion.rs.html#393-460" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub unsafe trait FromPyPointer<'p>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
||
unsafe fn <a href="#tymethod.from_owned_ptr_or_opt" class="fnname">from_owned_ptr_or_opt</a>(<br> py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'p>, <br> ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../../pyo3/ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'p </a>Self>;
|
||
<div class="item-spacer"></div> unsafe fn <a href="#tymethod.from_borrowed_ptr_or_opt" class="fnname">from_borrowed_ptr_or_opt</a>(<br> py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'p>, <br> ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../../pyo3/ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'p </a>Self>;
|
||
|
||
unsafe fn <a href="#method.from_owned_ptr_or_panic" class="fnname">from_owned_ptr_or_panic</a>(<br> py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'p>, <br> ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../../pyo3/ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a><br> ) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'p </a>Self { ... }
|
||
<div class="item-spacer"></div> unsafe fn <a href="#method.from_owned_ptr" class="fnname">from_owned_ptr</a>(py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'p>, ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../../pyo3/ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'p </a>Self { ... }
|
||
<div class="item-spacer"></div> unsafe fn <a href="#method.from_owned_ptr_or_err" class="fnname">from_owned_ptr_or_err</a>(<br> py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'p>, <br> ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../../pyo3/ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a><br> ) -> <a class="type" href="../../pyo3/prelude/type.PyResult.html" title="type pyo3::prelude::PyResult">PyResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'p </a>Self> { ... }
|
||
<div class="item-spacer"></div> unsafe fn <a href="#method.from_borrowed_ptr_or_panic" class="fnname">from_borrowed_ptr_or_panic</a>(<br> py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'p>, <br> ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../../pyo3/ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a><br> ) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'p </a>Self { ... }
|
||
<div class="item-spacer"></div> unsafe fn <a href="#method.from_borrowed_ptr" class="fnname">from_borrowed_ptr</a>(py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'p>, ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../../pyo3/ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'p </a>Self { ... }
|
||
<div class="item-spacer"></div> unsafe fn <a href="#method.from_borrowed_ptr_or_err" class="fnname">from_borrowed_ptr_or_err</a>(<br> py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'p>, <br> ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../../pyo3/ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a><br> ) -> <a class="type" href="../../pyo3/prelude/type.PyResult.html" title="type pyo3::prelude::PyResult">PyResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'p </a>Self> { ... }
|
||
}</pre></div><div class="docblock"><p>Raw level conversion between <code>*mut ffi::PyObject</code> and PyO3 types.</p>
|
||
</div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.from_owned_ptr_or_opt" class="method"><code>unsafe fn <a href="#tymethod.from_owned_ptr_or_opt" class="fnname">from_owned_ptr_or_opt</a>(<br> py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'p>, <br> ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../../pyo3/ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'p </a>Self></code><a class="srclink" href="../../src/pyo3/conversion.rs.html#401" title="goto source code">[src]</a></h3><div class="docblock"><p>Convert from an arbitrary <code>PyObject</code>.</p>
|
||
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
|
||
<p>Implementations must ensure the object does not get freed during <code>'p</code>
|
||
and ensure that <code>ptr</code> is of the correct type.
|
||
Note that it must be safe to decrement the reference count of <code>ptr</code>.</p>
|
||
</div><h3 id="tymethod.from_borrowed_ptr_or_opt" class="method"><code>unsafe fn <a href="#tymethod.from_borrowed_ptr_or_opt" class="fnname">from_borrowed_ptr_or_opt</a>(<br> py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'p>, <br> ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../../pyo3/ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'p </a>Self></code><a class="srclink" href="../../src/pyo3/conversion.rs.html#431-432" title="goto source code">[src]</a></h3><div class="docblock"><p>Convert from an arbitrary borrowed <code>PyObject</code>.</p>
|
||
<h1 id="safety-1" class="section-header"><a href="#safety-1">Safety</a></h1>
|
||
<p>Implementations must ensure the object does not get freed during <code>'p</code> and avoid type confusion.</p>
|
||
</div></div><span class="loading-content">Loading content...</span><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><h3 id="method.from_owned_ptr_or_panic" class="method"><code>unsafe fn <a href="#method.from_owned_ptr_or_panic" class="fnname">from_owned_ptr_or_panic</a>(<br> py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'p>, <br> ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../../pyo3/ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a><br>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'p </a>Self</code><a class="srclink" href="../../src/pyo3/conversion.rs.html#407-409" title="goto source code">[src]</a></h3><div class="docblock"><p>Convert from an arbitrary <code>PyObject</code> or panic.</p>
|
||
<h1 id="safety-2" class="section-header"><a href="#safety-2">Safety</a></h1>
|
||
<p>Relies on <a href="#method.from_owned_ptr_or_opt"><code>from_owned_ptr_or_opt</code></a>.</p>
|
||
</div><h3 id="method.from_owned_ptr" class="method"><code>unsafe fn <a href="#method.from_owned_ptr" class="fnname">from_owned_ptr</a>(py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'p>, ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../../pyo3/ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'p </a>Self</code><a class="srclink" href="../../src/pyo3/conversion.rs.html#415-417" title="goto source code">[src]</a></h3><div class="docblock"><p>Convert from an arbitrary <code>PyObject</code> or panic.</p>
|
||
<h1 id="safety-3" class="section-header"><a href="#safety-3">Safety</a></h1>
|
||
<p>Relies on <a href="#method.from_owned_ptr_or_opt"><code>from_owned_ptr_or_opt</code></a>.</p>
|
||
</div><h3 id="method.from_owned_ptr_or_err" class="method"><code>unsafe fn <a href="#method.from_owned_ptr_or_err" class="fnname">from_owned_ptr_or_err</a>(<br> py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'p>, <br> ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../../pyo3/ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a><br>) -> <a class="type" href="../../pyo3/prelude/type.PyResult.html" title="type pyo3::prelude::PyResult">PyResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'p </a>Self></code><a class="srclink" href="../../src/pyo3/conversion.rs.html#423-425" title="goto source code">[src]</a></h3><div class="docblock"><p>Convert from an arbitrary <code>PyObject</code>.</p>
|
||
<h1 id="safety-4" class="section-header"><a href="#safety-4">Safety</a></h1>
|
||
<p>Relies on <a href="#method.from_owned_ptr_or_opt"><code>from_owned_ptr_or_opt</code></a>.</p>
|
||
</div><h3 id="method.from_borrowed_ptr_or_panic" class="method"><code>unsafe fn <a href="#method.from_borrowed_ptr_or_panic" class="fnname">from_borrowed_ptr_or_panic</a>(<br> py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'p>, <br> ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../../pyo3/ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a><br>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'p </a>Self</code><a class="srclink" href="../../src/pyo3/conversion.rs.html#438-440" title="goto source code">[src]</a></h3><div class="docblock"><p>Convert from an arbitrary borrowed <code>PyObject</code>.</p>
|
||
<h1 id="safety-5" class="section-header"><a href="#safety-5">Safety</a></h1>
|
||
<p>Relies on unsafe fn <a href="#method.from_borrowed_ptr_or_opt"><code>from_borrowed_ptr_or_opt</code></a>.</p>
|
||
</div><h3 id="method.from_borrowed_ptr" class="method"><code>unsafe fn <a href="#method.from_borrowed_ptr" class="fnname">from_borrowed_ptr</a>(py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'p>, ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../../pyo3/ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'p </a>Self</code><a class="srclink" href="../../src/pyo3/conversion.rs.html#446-448" title="goto source code">[src]</a></h3><div class="docblock"><p>Convert from an arbitrary borrowed <code>PyObject</code>.</p>
|
||
<h1 id="safety-6" class="section-header"><a href="#safety-6">Safety</a></h1>
|
||
<p>Relies on unsafe fn <a href="#method.from_borrowed_ptr_or_opt"><code>from_borrowed_ptr_or_opt</code></a>.</p>
|
||
</div><h3 id="method.from_borrowed_ptr_or_err" class="method"><code>unsafe fn <a href="#method.from_borrowed_ptr_or_err" class="fnname">from_borrowed_ptr_or_err</a>(<br> py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'p>, <br> ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../../pyo3/ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a><br>) -> <a class="type" href="../../pyo3/prelude/type.PyResult.html" title="type pyo3::prelude::PyResult">PyResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'p </a>Self></code><a class="srclink" href="../../src/pyo3/conversion.rs.html#454-459" title="goto source code">[src]</a></h3><div class="docblock"><p>Convert from an arbitrary borrowed <code>PyObject</code>.</p>
|
||
<h1 id="safety-7" class="section-header"><a href="#safety-7">Safety</a></h1>
|
||
<p>Relies on unsafe fn <a href="#method.from_borrowed_ptr_or_opt"><code>from_borrowed_ptr_or_opt</code></a>.</p>
|
||
</div></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><h3 id="impl-FromPyPointer%3C%27p%3E" class="impl"><code class="in-band">impl<'p, T> <a class="trait" href="../../pyo3/conversion/trait.FromPyPointer.html" title="trait pyo3::conversion::FromPyPointer">FromPyPointer</a><'p> for T <span class="where fmt-newline">where<br> T: 'p + <a class="trait" href="../../pyo3/trait.PyNativeType.html" title="trait pyo3::PyNativeType">PyNativeType</a>, </span></code><a href="#impl-FromPyPointer%3C%27p%3E" class="anchor"></a><a class="srclink" href="../../src/pyo3/conversion.rs.html#462-476" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from_owned_ptr_or_opt" class="method hidden"><code>unsafe fn <a href="#method.from_owned_ptr_or_opt" class="fnname">from_owned_ptr_or_opt</a>(<br> py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'p>, <br> ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../../pyo3/ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'p </a>Self></code><a class="srclink" href="../../src/pyo3/conversion.rs.html#466-469" title="goto source code">[src]</a></h4><h4 id="method.from_borrowed_ptr_or_opt" class="method hidden"><code>unsafe fn <a href="#method.from_borrowed_ptr_or_opt" class="fnname">from_borrowed_ptr_or_opt</a>(<br> _py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'p>, <br> ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../../pyo3/ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'p </a>Self></code><a class="srclink" href="../../src/pyo3/conversion.rs.html#470-475" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/pyo3/conversion/trait.FromPyPointer.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="pyo3" data-search-js="../../search-index.js"></div>
|
||
<script src="../../main.js"></script></body></html> |