github-actions[bot]
12 lines
9.5 KiB
HTML
12 lines
9.5 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="This trait allows retrieving the underlying FFI pointer from Python objects."><meta name="keywords" content="rust, rustlang, rust-lang, IntoPyPointer"><title>IntoPyPointer in pyo3::conversion - 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 11]><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 IntoPyPointer</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.into_ptr">into_ptr</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-IntoPyPointer-for-%26%27a%20T">&'a T</a><a href="#impl-IntoPyPointer-for-Option%3CT%3E">Option<T></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="IntoPyPointer" 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><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="">IntoPyPointer</a><button id="copy-path" onclick="copy_path(this)">⎘</button></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#32-36" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><pre class="rust trait">pub trait IntoPyPointer {
|
||
fn <a href="#tymethod.into_ptr" class="fnname">into_ptr</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a>;
|
||
}</pre></div><div class="docblock"><p>This trait allows retrieving the underlying FFI pointer from Python objects.</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.into_ptr" class="method"><code>fn <a href="#tymethod.into_ptr" class="fnname">into_ptr</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a></code><a class="srclink" href="../../src/pyo3/conversion.rs.html#35" title="goto source code">[src]</a></h3><div class="docblock"><p>Retrieves the underlying FFI pointer. Whether pointer owned or borrowed
|
||
depends on implementation.</p>
|
||
</div></div><span class="loading-content">Loading content...</span><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle" open><summary><h3 id="impl-IntoPyPointer-for-Option%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="trait.IntoPyPointer.html" title="trait pyo3::conversion::IntoPyPointer">IntoPyPointer</a> for <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="trait.IntoPyPointer.html" title="trait pyo3::conversion::IntoPyPointer">IntoPyPointer</a>, </span></code><a href="#impl-IntoPyPointer-for-Option%3CT%3E" class="anchor"></a><a class="srclink" href="../../src/pyo3/conversion.rs.html#51-59" title="goto source code">[src]</a></h3></summary><div class="docblock"><p>Convert <code>None</code> into a null pointer.</p>
|
||
</div><div class="impl-items"><h4 id="method.into_ptr" class="method hidden trait-impl"><code>fn <a href="#tymethod.into_ptr" class="fnname">into_ptr</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a></code><a href="#method.into_ptr" class="anchor"></a><a class="srclink" href="../../src/pyo3/conversion.rs.html#56-58" title="goto source code">[src]</a></h4></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><h3 id="impl-IntoPyPointer-for-%26%27a%20T" class="impl"><code class="in-band">impl<'a, T> <a class="trait" href="trait.IntoPyPointer.html" title="trait pyo3::conversion::IntoPyPointer">IntoPyPointer</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>T <span class="where fmt-newline">where<br> T: <a class="trait" href="trait.AsPyPointer.html" title="trait pyo3::conversion::AsPyPointer">AsPyPointer</a>, </span></code><a href="#impl-IntoPyPointer-for-%26%27a%20T" class="anchor"></a><a class="srclink" href="../../src/pyo3/conversion.rs.html#61-74" title="goto source code">[src]</a></h3></summary><div class="impl-items"><h4 id="method.into_ptr-1" class="method hidden trait-impl"><code>fn <a href="#tymethod.into_ptr" class="fnname">into_ptr</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a></code><a href="#method.into_ptr-1" class="anchor"></a><a class="srclink" href="../../src/pyo3/conversion.rs.html#65-73" title="goto source code">[src]</a></h4></div></details><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"><details class="rustdoc-toggle implementors-toggle" open><summary><h3 id="impl-IntoPyPointer" class="impl"><code class="in-band">impl<T> <a class="trait" href="trait.IntoPyPointer.html" title="trait pyo3::conversion::IntoPyPointer">IntoPyPointer</a> for <a class="struct" href="../prelude/struct.Py.html" title="struct pyo3::prelude::Py">Py</a><T></code><a href="#impl-IntoPyPointer" class="anchor"></a><a class="srclink" href="../../src/pyo3/instance.rs.html#484-491" title="goto source code">[src]</a></h3></summary><div class="impl-items"><h4 id="method.into_ptr-2" class="method trait-impl"><code><div class="code-attribute">#[must_use]</div>fn <a href="#tymethod.into_ptr" class="fnname">into_ptr</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../ffi/struct.PyObject.html" title="struct pyo3::ffi::PyObject">PyObject</a></code><a href="#method.into_ptr-2" class="anchor"></a><a class="srclink" href="../../src/pyo3/instance.rs.html#488-490" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the underlying FFI pointer, returns a owned pointer.</p>
|
||
</div></div></details></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/pyo3/conversion/trait.IntoPyPointer.js" async></script></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="pyo3" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div>
|
||
<script src="../../main.js"></script></body></html> |