Auto Generated Documentation
This commit is contained in:
github-actions[bot]
@@ -1,17 +1,8 @@
|
||||
<!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="If `PyClass` is implemented for `T`, then we can use `T` in the Python world, via `PyCell`."><meta name="keywords" content="rust, rustlang, rust-lang, PyClass"><title>PyClass 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 PyClass</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.BaseNativeType">BaseNativeType</a><a href="#associatedtype.Dict">Dict</a><a href="#associatedtype.WeakRef">WeakRef</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="PyClass" 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="">PyClass</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#127-142" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><pre class="rust trait">pub trait PyClass: <a class="trait" href="../type_object/trait.PyTypeInfo.html" title="trait pyo3::type_object::PyTypeInfo">PyTypeInfo</a><Layout = <a class="struct" href="../pycell/struct.PyCell.html" title="struct pyo3::pycell::PyCell">PyCell</a><Self>, AsRefTarget = <a class="struct" href="../pycell/struct.PyCell.html" title="struct pyo3::pycell::PyCell">PyCell</a><Self>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="trait.PyClassSend.html" title="trait pyo3::pyclass::PyClassSend">PyClassSend</a> + <a class="trait" href="trait.PyClassAlloc.html" title="trait pyo3::pyclass::PyClassAlloc">PyClassAlloc</a> + PyMethods + PyProtoMethods {
|
||||
type <a href="#associatedtype.Dict" class="type">Dict</a>: <a class="trait" href="../pyclass_slots/trait.PyClassDict.html" title="trait pyo3::pyclass_slots::PyClassDict">PyClassDict</a>;
|
||||
type <a href="#associatedtype.WeakRef" class="type">WeakRef</a>: <a class="trait" href="../pyclass_slots/trait.PyClassWeakRef.html" title="trait pyo3::pyclass_slots::PyClassWeakRef">PyClassWeakRef</a>;
|
||||
type <a href="#associatedtype.BaseNativeType" class="type">BaseNativeType</a>: <a class="trait" href="../type_object/trait.PyTypeInfo.html" title="trait pyo3::type_object::PyTypeInfo">PyTypeInfo</a> + <a class="trait" href="../trait.PyNativeType.html" title="trait pyo3::PyNativeType">PyNativeType</a>;
|
||||
}</pre></div><div class="docblock"><p>If <code>PyClass</code> is implemented for <code>T</code>, then we can use <code>T</code> in the Python world,
|
||||
via <code>PyCell</code>.</p>
|
||||
<p>The <code>#[pyclass]</code> attribute automatically implements this trait for your Rust struct,
|
||||
so you don’t have to use this trait directly.</p>
|
||||
</div><h2 id="associated-types" class="small-section-header">Associated Types<a href="#associated-types" class="anchor"></a></h2><div class="methods"><h3 id="associatedtype.Dict" class="method"><code>type <a href="#associatedtype.Dict" class="type">Dict</a>: <a class="trait" href="../pyclass_slots/trait.PyClassDict.html" title="trait pyo3::pyclass_slots::PyClassDict">PyClassDict</a></code><a class="srclink" href="../../src/pyo3/pyclass.rs.html#136" title="goto source code">[src]</a></h3><div class="docblock"><p>Specify this class has <code>#[pyclass(dict)]</code> or not.</p>
|
||||
</div><h3 id="associatedtype.WeakRef" class="method"><code>type <a href="#associatedtype.WeakRef" class="type">WeakRef</a>: <a class="trait" href="../pyclass_slots/trait.PyClassWeakRef.html" title="trait pyo3::pyclass_slots::PyClassWeakRef">PyClassWeakRef</a></code><a class="srclink" href="../../src/pyo3/pyclass.rs.html#138" title="goto source code">[src]</a></h3><div class="docblock"><p>Specify this class has <code>#[pyclass(weakref)]</code> or not.</p>
|
||||
</div><h3 id="associatedtype.BaseNativeType" class="method"><code>type <a href="#associatedtype.BaseNativeType" class="type">BaseNativeType</a>: <a class="trait" href="../type_object/trait.PyTypeInfo.html" title="trait pyo3::type_object::PyTypeInfo">PyTypeInfo</a> + <a class="trait" href="../trait.PyNativeType.html" title="trait pyo3::PyNativeType">PyNativeType</a></code><a class="srclink" href="../../src/pyo3/pyclass.rs.html#141" title="goto source code">[src]</a></h3><div class="docblock"><p>The closest native ancestor. This is <code>PyAny</code> by default, and when you declare
|
||||
<code>#[pyclass(extends=PyDict)]</code>, it’s <code>PyDict</code>.</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"></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/pyo3/pyclass/trait.PyClass.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>
|
||||
<!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="Types that can be used as Python classes."><title>PyClass in pyo3::pyclass - 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" 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 trait"><!--[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/index.html">pyo3</a><span class="version">0.24.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">PyClass</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Frozen" title="Frozen">Frozen</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In pyo3::<wbr>pyclass</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</a>::<wbr><a href="index.html">pyclass</a></span><h1>Trait <span class="trait">PyClass</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/pyclass.rs.html#16-21">Source</a> </span></div><pre class="rust item-decl"><code>pub trait PyClass: <a class="trait" href="../type_object/trait.PyTypeInfo.html" title="trait pyo3::type_object::PyTypeInfo">PyTypeInfo</a> + PyClassImpl {
|
||||
type <a href="#associatedtype.Frozen" class="associatedtype">Frozen</a>: Frozen;
|
||||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Types that can be used as Python classes.</p>
|
||||
<p>The <code>#[pyclass]</code> attribute implements this trait for your Rust struct -
|
||||
you shouldn’t implement this trait directly.</p>
|
||||
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Frozen" class="method"><a class="src rightside" href="../../src/pyo3/pyclass.rs.html#20">Source</a><h4 class="code-header">type <a href="#associatedtype.Frozen" class="associatedtype">Frozen</a>: Frozen</h4></section></summary><div class="docblock"><p>Whether the pyclass is frozen.</p>
|
||||
<p>This can be enabled via <code>#[pyclass(frozen)]</code>.</p>
|
||||
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.85.1/reference/items/traits.html#object-safety">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/pyo3/pyclass/trait.PyClass.js" async></script></section></div></main></body></html>
|
||||
Reference in New Issue
Block a user