Auto Generated Documentation

This commit is contained in:
github-actions[bot]
2021-06-27 15:50:04 +00:00
parent 8522fe43a5
commit e9a232e07d
7516 changed files with 69470 additions and 69332 deletions
@@ -1,15 +1,15 @@
<!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="Represents `__dict__` field for `#[pyclass]`."><meta name="keywords" content="rust, rustlang, rust-lang, PyClassDict"><title>pyo3::pyclass_slots::PyClassDict - 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">
<!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="Represents `__dict__` field for `#[pyclass]`."><meta name="keywords" content="rust, rustlang, rust-lang, PyClassDict"><title>PyClassDict in pyo3::pyclass_slots - 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">&#9776;</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 PyClassDict</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-const">Associated Constants</a><div class="sidebar-links"><a href="#associatedconstant.IS_DUMMY">IS_DUMMY</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.new">new</a><a href="#tymethod.__private__">__private__</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.clear_dict">clear_dict</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_slots</a></p><div id="sidebar-vars" data-name="PyClassDict" 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">pyclass_slots</a>::<wbr><a class="trait" href="">PyClassDict</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">&#x2212;</span>]</a></span><a class="srclink" href="../../src/pyo3/pyclass_slots.rs.html#6-11" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait PyClassDict {
<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">&#9776;</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 PyClassDict</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-const">Associated Constants</a><div class="sidebar-links"><a href="#associatedconstant.IS_DUMMY">IS_DUMMY</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.__private__">__private__</a><a href="#tymethod.new">new</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.clear_dict">clear_dict</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_slots</a></p><div id="sidebar-vars" data-name="PyClassDict" 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_slots</a>::<wbr><a class="trait" href="">PyClassDict</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">&#x2212;</span>]</a></span><a class="srclink" href="../../src/pyo3/pyclass_slots.rs.html#6-11" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><pre class="rust trait">pub trait PyClassDict {
const <a href="#associatedconstant.IS_DUMMY" class="constant"><b>IS_DUMMY</b></a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
fn <a href="#tymethod.new" class="fnname">new</a>() -&gt; Self;
<div class="item-spacer"></div> fn <a href="#tymethod.__private__" class="fnname">__private__</a>(&amp;self) -&gt; PrivateMarker;
fn <a href="#method.clear_dict" class="fnname">clear_dict</a>(&amp;mut self, _py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a>&lt;'_&gt;) { ... }
fn <a href="#method.clear_dict" class="fnname">clear_dict</a>(&amp;mut self, _py: <a class="struct" href="../prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a>&lt;'_&gt;) { ... }
}</pre></div><div class="docblock"><p>Represents <code>__dict__</code> field for <code>#[pyclass]</code>.</p>
</div><h2 id="associated-const" class="small-section-header">Associated Constants<a href="#associated-const" class="anchor"></a></h2><div class="methods"><h3 id="associatedconstant.IS_DUMMY" class="method"><code>const <a href="#associatedconstant.IS_DUMMY" class="constant"><b>IS_DUMMY</b></a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/pyo3/pyclass_slots.rs.html#7" title="goto source code">[src]</a></h3></div><span class="loading-content">Loading content...</span><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.new" class="method"><code>fn <a href="#tymethod.new" class="fnname">new</a>() -&gt; Self</code><a class="srclink" href="../../src/pyo3/pyclass_slots.rs.html#8" title="goto source code">[src]</a></h3><h3 id="tymethod.__private__" class="method"><code>fn <a href="#tymethod.__private__" class="fnname">__private__</a>(&amp;self) -&gt; PrivateMarker</code><a class="srclink" href="../../src/pyo3/pyclass_slots.rs.html#10" title="goto source code">[src]</a></h3><div class="docblock"><p>This trait is private to implement; this method exists to make it
impossible to implement outside the crate.</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.clear_dict" class="method"><code>fn <a href="#method.clear_dict" class="fnname">clear_dict</a>(&amp;mut self, _py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a>&lt;'_&gt;)</code><a class="srclink" href="../../src/pyo3/pyclass_slots.rs.html#9" title="goto source code">[src]</a></h3></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-PyClassDict" class="impl"><code class="in-band">impl <a class="trait" href="../../pyo3/pyclass_slots/trait.PyClassDict.html" title="trait pyo3::pyclass_slots::PyClassDict">PyClassDict</a> for <a class="struct" href="../../pyo3/pyclass_slots/struct.PyClassDictSlot.html" title="struct pyo3::pyclass_slots::PyClassDictSlot">PyClassDictSlot</a></code><a href="#impl-PyClassDict" class="anchor"></a><a class="srclink" href="../../src/pyo3/pyclass_slots.rs.html#44-55" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedconstant.IS_DUMMY-1" class="associatedconstant hidden"><code>const <a href="#associatedconstant.IS_DUMMY-1" class="constant"><b>IS_DUMMY</b></a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/pyo3/pyclass_slots.rs.html#46" title="goto source code">[src]</a></h4><h4 id="method.new" class="method hidden"><code>fn <a href="#method.new" class="fnname">new</a>() -&gt; Self</code><a class="srclink" href="../../src/pyo3/pyclass_slots.rs.html#47-49" title="goto source code">[src]</a></h4><h4 id="method.clear_dict-1" class="method hidden"><code>fn <a href="#method.clear_dict-1" class="fnname">clear_dict</a>(&amp;mut self, _py: <a class="struct" href="../../pyo3/prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a>&lt;'_&gt;)</code><a class="srclink" href="../../src/pyo3/pyclass_slots.rs.html#50-54" title="goto source code">[src]</a></h4></div><h3 id="impl-PyClassDict-1" class="impl"><code class="in-band">impl <a class="trait" href="../../pyo3/pyclass_slots/trait.PyClassDict.html" title="trait pyo3::pyclass_slots::PyClassDict">PyClassDict</a> for <a class="struct" href="../../pyo3/pyclass_slots/struct.PyClassDummySlot.html" title="struct pyo3::pyclass_slots::PyClassDummySlot">PyClassDummySlot</a></code><a href="#impl-PyClassDict-1" class="anchor"></a><a class="srclink" href="../../src/pyo3/pyclass_slots.rs.html#24-29" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.new-1" class="method hidden"><code>fn <a href="#method.new-1" class="fnname">new</a>() -&gt; Self</code><a class="srclink" href="../../src/pyo3/pyclass_slots.rs.html#26-28" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/pyo3/pyclass_slots/trait.PyClassDict.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>
</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.clear_dict" class="method"><code>fn <a href="#method.clear_dict" class="fnname">clear_dict</a>(&amp;mut self, _py: <a class="struct" href="../prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a>&lt;'_&gt;)</code><a class="srclink" href="../../src/pyo3/pyclass_slots.rs.html#9" title="goto source code">[src]</a></h3></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-PyClassDict" class="impl"><code class="in-band">impl <a class="trait" href="trait.PyClassDict.html" title="trait pyo3::pyclass_slots::PyClassDict">PyClassDict</a> for <a class="struct" href="struct.PyClassDictSlot.html" title="struct pyo3::pyclass_slots::PyClassDictSlot">PyClassDictSlot</a></code><a href="#impl-PyClassDict" class="anchor"></a><a class="srclink" href="../../src/pyo3/pyclass_slots.rs.html#44-55" title="goto source code">[src]</a></h3></summary><div class="impl-items"><h4 id="associatedconstant.IS_DUMMY-1" class="associatedconstant hidden trait-impl"><code>const <a href="#associatedconstant.IS_DUMMY" class="constant"><b>IS_DUMMY</b></a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a href="#associatedconstant.IS_DUMMY-1" class="anchor"></a><a class="srclink" href="../../src/pyo3/pyclass_slots.rs.html#46" title="goto source code">[src]</a></h4><h4 id="method.new" class="method hidden trait-impl"><code>fn <a href="#tymethod.new" class="fnname">new</a>() -&gt; Self</code><a href="#method.new" class="anchor"></a><a class="srclink" href="../../src/pyo3/pyclass_slots.rs.html#47-49" title="goto source code">[src]</a></h4><h4 id="method.clear_dict-1" class="method hidden trait-impl"><code>fn <a href="#method.clear_dict" class="fnname">clear_dict</a>(&amp;mut self, _py: <a class="struct" href="../prelude/struct.Python.html" title="struct pyo3::prelude::Python">Python</a>&lt;'_&gt;)</code><a href="#method.clear_dict-1" class="anchor"></a><a class="srclink" href="../../src/pyo3/pyclass_slots.rs.html#50-54" title="goto source code">[src]</a></h4></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><h3 id="impl-PyClassDict-1" class="impl"><code class="in-band">impl <a class="trait" href="trait.PyClassDict.html" title="trait pyo3::pyclass_slots::PyClassDict">PyClassDict</a> for <a class="struct" href="struct.PyClassDummySlot.html" title="struct pyo3::pyclass_slots::PyClassDummySlot">PyClassDummySlot</a></code><a href="#impl-PyClassDict-1" class="anchor"></a><a class="srclink" href="../../src/pyo3/pyclass_slots.rs.html#24-29" title="goto source code">[src]</a></h3></summary><div class="impl-items"><h4 id="method.new-1" class="method hidden trait-impl"><code>fn <a href="#tymethod.new" class="fnname">new</a>() -&gt; Self</code><a href="#method.new-1" class="anchor"></a><a class="srclink" href="../../src/pyo3/pyclass_slots.rs.html#26-28" 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_slots/trait.PyClassDict.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>