github-actions[bot]
15 lines
10 KiB
HTML
15 lines
10 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 enables custom `tp_new`/`tp_dealloc` implementations for `T: PyClass`."><meta name="keywords" content="rust, rustlang, rust-lang, PyClassAlloc"><title>PyClassAlloc in pyo3::pyclass - 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 PyClassAlloc</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.dealloc">dealloc</a><a href="#method.new">new</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">pyclass</a></p><div id="sidebar-vars" data-name="PyClassAlloc" 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">pyclass</a>::<wbr><a class="trait" href="">PyClassAlloc</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/pyclass.rs.html#75-103" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><pre class="rust trait">pub trait PyClassAlloc: <a class="trait" href="../type_object/trait.PyTypeInfo.html" title="trait pyo3::type_object::PyTypeInfo">PyTypeInfo</a> + <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="#method.new" class="fnname">new</a>(<br> py: <a class="struct" href="../prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'_>, <br> subtype: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../ffi/struct.PyTypeObject.html" title="struct pyo3::ffi::PyTypeObject">PyTypeObject</a><br> ) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a>Self::<a class="type" href="../type_object/trait.PyTypeInfo.html#associatedtype.Layout" title="type pyo3::type_object::PyTypeInfo::Layout">Layout</a> { ... }
|
||
<div class="item-spacer"></div> unsafe fn <a href="#method.dealloc" class="fnname">dealloc</a>(py: <a class="struct" href="../prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'_>, self_: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a>Self::<a class="type" href="../type_object/trait.PyTypeInfo.html#associatedtype.Layout" title="type pyo3::type_object::PyTypeInfo::Layout">Layout</a>) { ... }
|
||
}</pre></div><div class="docblock"><p>This trait enables custom <code>tp_new</code>/<code>tp_dealloc</code> implementations for <code>T: PyClass</code>.</p>
|
||
</div><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><h3 id="method.new" class="method"><code>unsafe fn <a href="#method.new" class="fnname">new</a>(py: <a class="struct" href="../prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'_>, subtype: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../ffi/struct.PyTypeObject.html" title="struct pyo3::ffi::PyTypeObject">PyTypeObject</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a>Self::<a class="type" href="../type_object/trait.PyTypeInfo.html#associatedtype.Layout" title="type pyo3::type_object::PyTypeInfo::Layout">Layout</a></code><a class="srclink" href="../../src/pyo3/pyclass.rs.html#80-82" title="goto source code">[src]</a></h3><div class="docblock"><p>Allocate the actual field for <code>#[pyclass]</code>.</p>
|
||
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
|
||
<p>This function must return a valid pointer to the Python heap.</p>
|
||
</div><h3 id="method.dealloc" class="method"><code>unsafe fn <a href="#method.dealloc" class="fnname">dealloc</a>(py: <a class="struct" href="../prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'_>, self_: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a>Self::<a class="type" href="../type_object/trait.PyTypeInfo.html#associatedtype.Layout" title="type pyo3::type_object::PyTypeInfo::Layout">Layout</a>)</code><a class="srclink" href="../../src/pyo3/pyclass.rs.html#89-102" title="goto source code">[src]</a></h3><div class="docblock"><p>Deallocate <code>#[pyclass]</code> on the Python heap.</p>
|
||
<h1 id="safety-1" class="section-header"><a href="#safety-1">Safety</a></h1>
|
||
<p><code>self_</code> must be a valid pointer to the Python heap.</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"><details class="rustdoc-toggle implementors-toggle" open><summary><h3 id="impl-PyClassAlloc" class="impl"><code class="in-band">impl<T> <a class="trait" href="trait.PyClassAlloc.html" title="trait pyo3::pyclass::PyClassAlloc">PyClassAlloc</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="../type_object/trait.PyTypeInfo.html" title="trait pyo3::type_object::PyTypeInfo">PyTypeInfo</a> + <a class="trait" href="../freelist/trait.PyClassWithFreeList.html" title="trait pyo3::freelist::PyClassWithFreeList">PyClassWithFreeList</a>, </span></code><a href="#impl-PyClassAlloc" class="anchor"></a><a class="srclink" href="../../src/pyo3/freelist.rs.html#70-104" title="goto source code">[src]</a></h3></summary><div class="impl-items"><h4 id="method.new-1" class="method hidden trait-impl"><code>unsafe fn <a href="#method.new" class="fnname">new</a>(py: <a class="struct" href="../prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'_>, subtype: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="../ffi/struct.PyTypeObject.html" title="struct pyo3::ffi::PyTypeObject">PyTypeObject</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a>Self::<a class="type" href="../type_object/trait.PyTypeInfo.html#associatedtype.Layout" title="type pyo3::type_object::PyTypeInfo::Layout">Layout</a></code><a href="#method.new-1" class="anchor"></a><a class="srclink" href="../../src/pyo3/freelist.rs.html#74-85" title="goto source code">[src]</a></h4><h4 id="method.dealloc-1" class="method hidden trait-impl"><code>unsafe fn <a href="#method.dealloc" class="fnname">dealloc</a>(py: <a class="struct" href="../prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a><'_>, self_: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a>Self::<a class="type" href="../type_object/trait.PyTypeInfo.html#associatedtype.Layout" title="type pyo3::type_object::PyTypeInfo::Layout">Layout</a>)</code><a href="#method.dealloc-1" class="anchor"></a><a class="srclink" href="../../src/pyo3/freelist.rs.html#88-103" title="goto source code">[src]</a></h4></div></details></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/pyo3/pyclass/trait.PyClassAlloc.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> |