Auto Generated Documentation
This commit is contained in:
github-actions[bot]
@@ -1,10 +1,10 @@
|
||||
<!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="Python Iterator Interface."><meta name="keywords" content="rust, rustlang, rust-lang, PyIterProtocol"><title>pyo3::class::iter::PyIterProtocol - 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="Python Iterator Interface."><meta name="keywords" content="rust, rustlang, rust-lang, PyIterProtocol"><title>PyIterProtocol in pyo3::class::iter - 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">☰</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 PyIterProtocol</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.__iter__">__iter__</a><a href="#method.__next__">__next__</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">class</a>::<wbr><a href="index.html">iter</a></p><div id="sidebar-vars" data-name="PyIterProtocol" 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">class</a>::<wbr><a href="index.html">iter</a>::<wbr><a class="trait" href="">PyIterProtocol</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">−</span>]</a></span><a class="srclink" href="../../../src/pyo3/class/iter.rs.html#48-62" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait PyIterProtocol<'p>: <a class="trait" href="../../../pyo3/pyclass/trait.PyClass.html" title="trait pyo3::pyclass::PyClass">PyClass</a> {
|
||||
fn <a href="#method.__iter__" class="fnname">__iter__</a>(slf: Self::<a class="type" href="../../../pyo3/class/iter/trait.PyIterIterProtocol.html#associatedtype.Receiver" title="type pyo3::class::iter::PyIterIterProtocol::Receiver">Receiver</a>) -> Self::<a class="type" href="../../../pyo3/class/iter/trait.PyIterIterProtocol.html#associatedtype.Result" title="type pyo3::class::iter::PyIterIterProtocol::Result">Result</a><br> <span class="where">where<br> Self: <a class="trait" href="../../../pyo3/class/iter/trait.PyIterIterProtocol.html" title="trait pyo3::class::iter::PyIterIterProtocol">PyIterIterProtocol</a><'p></span>,
|
||||
<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 PyIterProtocol</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.__iter__">__iter__</a><a href="#method.__next__">__next__</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">class</a>::<wbr><a href="index.html">iter</a></p><div id="sidebar-vars" data-name="PyIterProtocol" 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">class</a>::<wbr><a href="index.html">iter</a>::<wbr><a class="trait" href="">PyIterProtocol</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/iter.rs.html#48-62" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><pre class="rust trait">pub trait PyIterProtocol<'p>: <a class="trait" href="../../pyclass/trait.PyClass.html" title="trait pyo3::pyclass::PyClass">PyClass</a> {
|
||||
fn <a href="#method.__iter__" class="fnname">__iter__</a>(slf: Self::<a class="type" href="trait.PyIterIterProtocol.html#associatedtype.Receiver" title="type pyo3::class::iter::PyIterIterProtocol::Receiver">Receiver</a>) -> Self::<a class="type" href="trait.PyIterIterProtocol.html#associatedtype.Result" title="type pyo3::class::iter::PyIterIterProtocol::Result">Result</a><br> <span class="where">where<br> Self: <a class="trait" href="trait.PyIterIterProtocol.html" title="trait pyo3::class::iter::PyIterIterProtocol">PyIterIterProtocol</a><'p></span>,
|
||||
{ ... }
|
||||
<div class="item-spacer"></div> fn <a href="#method.__next__" class="fnname">__next__</a>(slf: Self::<a class="type" href="../../../pyo3/class/iter/trait.PyIterNextProtocol.html#associatedtype.Receiver" title="type pyo3::class::iter::PyIterNextProtocol::Receiver">Receiver</a>) -> Self::<a class="type" href="../../../pyo3/class/iter/trait.PyIterNextProtocol.html#associatedtype.Result" title="type pyo3::class::iter::PyIterNextProtocol::Result">Result</a><br> <span class="where">where<br> Self: <a class="trait" href="../../../pyo3/class/iter/trait.PyIterNextProtocol.html" title="trait pyo3::class::iter::PyIterNextProtocol">PyIterNextProtocol</a><'p></span>,
|
||||
<div class="item-spacer"></div> fn <a href="#method.__next__" class="fnname">__next__</a>(slf: Self::<a class="type" href="trait.PyIterNextProtocol.html#associatedtype.Receiver" title="type pyo3::class::iter::PyIterNextProtocol::Receiver">Receiver</a>) -> Self::<a class="type" href="trait.PyIterNextProtocol.html#associatedtype.Result" title="type pyo3::class::iter::PyIterNextProtocol::Result">Result</a><br> <span class="where">where<br> Self: <a class="trait" href="trait.PyIterNextProtocol.html" title="trait pyo3::class::iter::PyIterNextProtocol">PyIterNextProtocol</a><'p></span>,
|
||||
{ ... }
|
||||
}</pre></div><div class="docblock"><p>Python Iterator Interface.</p>
|
||||
<p>Check <a href="https://docs.python.org/3/c-api/typeobj.html#c.PyTypeObject.tp_iter">CPython doc</a>
|
||||
@@ -14,9 +14,9 @@ for more.</p>
|
||||
the integers 1 to 5, before raising <code>StopIteration("Ended")</code>.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">use</span> <span class="ident">pyo3</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;
|
||||
<span class="kw">use</span> <span class="ident">pyo3</span>::<span class="ident">PyIterProtocol</span>;
|
||||
<span class="kw">use</span> <span class="ident">pyo3</span>::<span class="ident">class</span>::<span class="ident">iter</span>::<span class="ident">IterNextOutput</span>;
|
||||
<span class="kw">use</span> <span class="ident">pyo3::prelude</span>::<span class="kw-2">*</span>;
|
||||
<span class="kw">use</span> <span class="ident">pyo3::PyIterProtocol</span>;
|
||||
<span class="kw">use</span> <span class="ident">pyo3::class::iter::IterNextOutput</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">pyclass</span>]</span>
|
||||
<span class="kw">struct</span> <span class="ident">Iter</span> {
|
||||
@@ -28,12 +28,12 @@ the integers 1 to 5, before raising <code>StopIteration("Ended")</code
|
||||
<span class="kw">fn</span> <span class="ident">__next__</span>(<span class="kw-2">mut</span> <span class="ident">slf</span>: <span class="ident">PyRefMut</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">IterNextOutput</span><span class="op"><</span><span class="ident">usize</span>, <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span><span class="op">></span> {
|
||||
<span class="kw">if</span> <span class="ident">slf</span>.<span class="ident">count</span> <span class="op"><</span> <span class="number">5</span> {
|
||||
<span class="ident">slf</span>.<span class="ident">count</span> <span class="op">+</span><span class="op">=</span> <span class="number">1</span>;
|
||||
<span class="ident">IterNextOutput</span>::<span class="ident">Yield</span>(<span class="ident">slf</span>.<span class="ident">count</span>)
|
||||
<span class="ident">IterNextOutput::Yield</span>(<span class="ident">slf</span>.<span class="ident">count</span>)
|
||||
} <span class="kw">else</span> {
|
||||
<span class="ident">IterNextOutput</span>::<span class="ident">Return</span>(<span class="string">"Ended"</span>)
|
||||
<span class="ident">IterNextOutput::Return</span>(<span class="string">"Ended"</span>)
|
||||
}
|
||||
}
|
||||
}
|
||||
</pre></div>
|
||||
</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.__iter__" class="method"><code>fn <a href="#method.__iter__" class="fnname">__iter__</a>(slf: Self::<a class="type" href="../../../pyo3/class/iter/trait.PyIterIterProtocol.html#associatedtype.Receiver" title="type pyo3::class::iter::PyIterIterProtocol::Receiver">Receiver</a>) -> Self::<a class="type" href="../../../pyo3/class/iter/trait.PyIterIterProtocol.html#associatedtype.Result" title="type pyo3::class::iter::PyIterIterProtocol::Result">Result</a> <span class="where fmt-newline">where<br> Self: <a class="trait" href="../../../pyo3/class/iter/trait.PyIterIterProtocol.html" title="trait pyo3::class::iter::PyIterIterProtocol">PyIterIterProtocol</a><'p>, </span></code><a class="srclink" href="../../../src/pyo3/class/iter.rs.html#49-54" title="goto source code">[src]</a></h3><h3 id="method.__next__" class="method"><code>fn <a href="#method.__next__" class="fnname">__next__</a>(slf: Self::<a class="type" href="../../../pyo3/class/iter/trait.PyIterNextProtocol.html#associatedtype.Receiver" title="type pyo3::class::iter::PyIterNextProtocol::Receiver">Receiver</a>) -> Self::<a class="type" href="../../../pyo3/class/iter/trait.PyIterNextProtocol.html#associatedtype.Result" title="type pyo3::class::iter::PyIterNextProtocol::Result">Result</a> <span class="where fmt-newline">where<br> Self: <a class="trait" href="../../../pyo3/class/iter/trait.PyIterNextProtocol.html" title="trait pyo3::class::iter::PyIterNextProtocol">PyIterNextProtocol</a><'p>, </span></code><a class="srclink" href="../../../src/pyo3/class/iter.rs.html#56-61" 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"></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../../implementors/pyo3/class/iter/trait.PyIterProtocol.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><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><h3 id="method.__iter__" class="method"><code>fn <a href="#method.__iter__" class="fnname">__iter__</a>(slf: Self::<a class="type" href="trait.PyIterIterProtocol.html#associatedtype.Receiver" title="type pyo3::class::iter::PyIterIterProtocol::Receiver">Receiver</a>) -> Self::<a class="type" href="trait.PyIterIterProtocol.html#associatedtype.Result" title="type pyo3::class::iter::PyIterIterProtocol::Result">Result</a> <span class="where fmt-newline">where<br> Self: <a class="trait" href="trait.PyIterIterProtocol.html" title="trait pyo3::class::iter::PyIterIterProtocol">PyIterIterProtocol</a><'p>, </span></code><a class="srclink" href="../../../src/pyo3/class/iter.rs.html#49-54" title="goto source code">[src]</a></h3><h3 id="method.__next__" class="method"><code>fn <a href="#method.__next__" class="fnname">__next__</a>(slf: Self::<a class="type" href="trait.PyIterNextProtocol.html#associatedtype.Receiver" title="type pyo3::class::iter::PyIterNextProtocol::Receiver">Receiver</a>) -> Self::<a class="type" href="trait.PyIterNextProtocol.html#associatedtype.Result" title="type pyo3::class::iter::PyIterNextProtocol::Result">Result</a> <span class="where fmt-newline">where<br> Self: <a class="trait" href="trait.PyIterNextProtocol.html" title="trait pyo3::class::iter::PyIterNextProtocol">PyIterNextProtocol</a><'p>, </span></code><a class="srclink" href="../../../src/pyo3/class/iter.rs.html#56-61" 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"></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../../implementors/pyo3/class/iter/trait.PyIterProtocol.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>
|
||||
Reference in New Issue
Block a user