Auto Generated Documentation
This commit is contained in:
github-actions[bot]
@@ -1,14 +1,6 @@
|
||||
<!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="Basic Python Object customization"><meta name="keywords" content="rust, rustlang, rust-lang, basic"><title>pyo3::class::basic - 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 mod"><!--[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">Module basic</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></div><p class="location"><a href="../../index.html">pyo3</a>::<wbr><a href="../index.html">class</a></p><div id="sidebar-vars" data-name="basic" data-ty="mod" 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">Module <a href="../../index.html">pyo3</a>::<wbr><a href="../index.html">class</a>::<wbr><a class="mod" href="">basic</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/class/basic.rs.html#3-205" title="goto source code">[src]</a></span></h1><div class="docblock"><p>Basic Python Object customization</p>
|
||||
<p>Check <a href="https://docs.python.org/3/reference/datamodel.html#basic-customization">the Python C API information</a>
|
||||
for more information.</p>
|
||||
<p>Parts of the documentation are copied from the respective methods from the
|
||||
<a href="https://docs.python.org/3/c-api/typeobj.html">typeobj docs</a></p>
|
||||
</div><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
|
||||
<table><tr class="module-item"><td><a class="enum" href="enum.CompareOp.html" title="pyo3::class::basic::CompareOp enum">CompareOp</a></td><td class="docblock-short"><p>Operators for the <strong>richcmp</strong> method</p>
|
||||
</td></tr></table><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2>
|
||||
<table><tr class="module-item"><td><a class="trait" href="trait.PyObjectBoolProtocol.html" title="pyo3::class::basic::PyObjectBoolProtocol trait">PyObjectBoolProtocol</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="trait" href="trait.PyObjectBytesProtocol.html" title="pyo3::class::basic::PyObjectBytesProtocol trait">PyObjectBytesProtocol</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="trait" href="trait.PyObjectDelAttrProtocol.html" title="pyo3::class::basic::PyObjectDelAttrProtocol trait">PyObjectDelAttrProtocol</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="trait" href="trait.PyObjectFormatProtocol.html" title="pyo3::class::basic::PyObjectFormatProtocol trait">PyObjectFormatProtocol</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="trait" href="trait.PyObjectGetAttrProtocol.html" title="pyo3::class::basic::PyObjectGetAttrProtocol trait">PyObjectGetAttrProtocol</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="trait" href="trait.PyObjectHashProtocol.html" title="pyo3::class::basic::PyObjectHashProtocol trait">PyObjectHashProtocol</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="trait" href="trait.PyObjectProtocol.html" title="pyo3::class::basic::PyObjectProtocol trait">PyObjectProtocol</a></td><td class="docblock-short"><p>Basic Python class customization</p>
|
||||
</td></tr><tr class="module-item"><td><a class="trait" href="trait.PyObjectReprProtocol.html" title="pyo3::class::basic::PyObjectReprProtocol trait">PyObjectReprProtocol</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="trait" href="trait.PyObjectRichcmpProtocol.html" title="pyo3::class::basic::PyObjectRichcmpProtocol trait">PyObjectRichcmpProtocol</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="trait" href="trait.PyObjectSetAttrProtocol.html" title="pyo3::class::basic::PyObjectSetAttrProtocol trait">PyObjectSetAttrProtocol</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="trait" href="trait.PyObjectStrProtocol.html" title="pyo3::class::basic::PyObjectStrProtocol trait">PyObjectStrProtocol</a></td><td class="docblock-short"></td></tr></table></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="Old module which contained some implementation details of the `#[pyproto]` module."><title>pyo3::class::basic - 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 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/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="#">Module basic</a></h2><h3><a href="#reexports">Module Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In pyo3::<wbr>class</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">class</a></span><h1>Module <span>basic</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/lib.rs.html#397">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Old module which contained some implementation details of the <code>#[pyproto]</code> module.</p>
|
||||
<p>Prefer using the same content from <code>pyo3::pyclass</code>, e.g. <code>use pyo3::pyclass::CompareOp</code> instead
|
||||
of <code>use pyo3::class::basic::CompareOp</code>.</p>
|
||||
<p>For compatibility reasons this has not yet been removed, however will be done so
|
||||
once <a href="https://github.com/rust-lang/rust/issues/30827">https://github.com/rust-lang/rust/issues/30827</a> is resolved.</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.CompareOp"><code>pub use crate::pyclass::<a class="enum" href="../../pyclass/enum.CompareOp.html" title="enum pyo3::pyclass::CompareOp">CompareOp</a>;</code></div></li></ul></section></div></main></body></html>
|
||||
Reference in New Issue
Block a user