github-actions[bot]
18 lines
15 KiB
HTML
18 lines
15 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="Python Async/Await support interface."><meta name="keywords" content="rust, rustlang, rust-lang, PyAsyncProtocol"><title>pyo3::class::pyasync::PyAsyncProtocol - 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 PyAsyncProtocol</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.__await__">__await__</a><a href="#method.__aiter__">__aiter__</a><a href="#method.__anext__">__anext__</a><a href="#method.__aenter__">__aenter__</a><a href="#method.__aexit__">__aexit__</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">pyasync</a></p><div id="sidebar-vars" data-name="PyAsyncProtocol" 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">pyasync</a>::<wbr><a class="trait" href="">PyAsyncProtocol</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/pyasync.rs.html#20-60" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait PyAsyncProtocol<'p>: <a class="trait" href="../../../pyo3/pyclass/trait.PyClass.html" title="trait pyo3::pyclass::PyClass">PyClass</a> {
|
||
fn <a href="#method.__await__" class="fnname">__await__</a>(slf: Self::<a class="type" href="../../../pyo3/class/pyasync/trait.PyAsyncAwaitProtocol.html#associatedtype.Receiver" title="type pyo3::class::pyasync::PyAsyncAwaitProtocol::Receiver">Receiver</a>) -> Self::<a class="type" href="../../../pyo3/class/pyasync/trait.PyAsyncAwaitProtocol.html#associatedtype.Result" title="type pyo3::class::pyasync::PyAsyncAwaitProtocol::Result">Result</a><br> <span class="where">where<br> Self: <a class="trait" href="../../../pyo3/class/pyasync/trait.PyAsyncAwaitProtocol.html" title="trait pyo3::class::pyasync::PyAsyncAwaitProtocol">PyAsyncAwaitProtocol</a><'p></span>,
|
||
{ ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.__aiter__" class="fnname">__aiter__</a>(slf: Self::<a class="type" href="../../../pyo3/class/pyasync/trait.PyAsyncAiterProtocol.html#associatedtype.Receiver" title="type pyo3::class::pyasync::PyAsyncAiterProtocol::Receiver">Receiver</a>) -> Self::<a class="type" href="../../../pyo3/class/pyasync/trait.PyAsyncAiterProtocol.html#associatedtype.Result" title="type pyo3::class::pyasync::PyAsyncAiterProtocol::Result">Result</a><br> <span class="where">where<br> Self: <a class="trait" href="../../../pyo3/class/pyasync/trait.PyAsyncAiterProtocol.html" title="trait pyo3::class::pyasync::PyAsyncAiterProtocol">PyAsyncAiterProtocol</a><'p></span>,
|
||
{ ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.__anext__" class="fnname">__anext__</a>(slf: Self::<a class="type" href="../../../pyo3/class/pyasync/trait.PyAsyncAnextProtocol.html#associatedtype.Receiver" title="type pyo3::class::pyasync::PyAsyncAnextProtocol::Receiver">Receiver</a>) -> Self::<a class="type" href="../../../pyo3/class/pyasync/trait.PyAsyncAnextProtocol.html#associatedtype.Result" title="type pyo3::class::pyasync::PyAsyncAnextProtocol::Result">Result</a><br> <span class="where">where<br> Self: <a class="trait" href="../../../pyo3/class/pyasync/trait.PyAsyncAnextProtocol.html" title="trait pyo3::class::pyasync::PyAsyncAnextProtocol">PyAsyncAnextProtocol</a><'p></span>,
|
||
{ ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.__aenter__" class="fnname">__aenter__</a>(&'p mut self) -> Self::<a class="type" href="../../../pyo3/class/pyasync/trait.PyAsyncAenterProtocol.html#associatedtype.Result" title="type pyo3::class::pyasync::PyAsyncAenterProtocol::Result">Result</a><br> <span class="where">where<br> Self: <a class="trait" href="../../../pyo3/class/pyasync/trait.PyAsyncAenterProtocol.html" title="trait pyo3::class::pyasync::PyAsyncAenterProtocol">PyAsyncAenterProtocol</a><'p></span>,
|
||
{ ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.__aexit__" class="fnname">__aexit__</a>(<br> &'p mut self, <br> exc_type: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self::<a class="type" href="../../../pyo3/class/pyasync/trait.PyAsyncAexitProtocol.html#associatedtype.ExcType" title="type pyo3::class::pyasync::PyAsyncAexitProtocol::ExcType">ExcType</a>>, <br> exc_value: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self::<a class="type" href="../../../pyo3/class/pyasync/trait.PyAsyncAexitProtocol.html#associatedtype.ExcValue" title="type pyo3::class::pyasync::PyAsyncAexitProtocol::ExcValue">ExcValue</a>>, <br> traceback: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self::<a class="type" href="../../../pyo3/class/pyasync/trait.PyAsyncAexitProtocol.html#associatedtype.Traceback" title="type pyo3::class::pyasync::PyAsyncAexitProtocol::Traceback">Traceback</a>><br> ) -> Self::<a class="type" href="../../../pyo3/class/pyasync/trait.PyAsyncAexitProtocol.html#associatedtype.Result" title="type pyo3::class::pyasync::PyAsyncAexitProtocol::Result">Result</a><br> <span class="where">where<br> Self: <a class="trait" href="../../../pyo3/class/pyasync/trait.PyAsyncAexitProtocol.html" title="trait pyo3::class::pyasync::PyAsyncAexitProtocol">PyAsyncAexitProtocol</a><'p></span>,
|
||
{ ... }
|
||
}</pre></div><div class="docblock"><p>Python Async/Await support interface.</p>
|
||
<p>Each method in this trait corresponds to Python async/await implementation.</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.__await__" class="method"><code>fn <a href="#method.__await__" class="fnname">__await__</a>(slf: Self::<a class="type" href="../../../pyo3/class/pyasync/trait.PyAsyncAwaitProtocol.html#associatedtype.Receiver" title="type pyo3::class::pyasync::PyAsyncAwaitProtocol::Receiver">Receiver</a>) -> Self::<a class="type" href="../../../pyo3/class/pyasync/trait.PyAsyncAwaitProtocol.html#associatedtype.Result" title="type pyo3::class::pyasync::PyAsyncAwaitProtocol::Result">Result</a> <span class="where fmt-newline">where<br> Self: <a class="trait" href="../../../pyo3/class/pyasync/trait.PyAsyncAwaitProtocol.html" title="trait pyo3::class::pyasync::PyAsyncAwaitProtocol">PyAsyncAwaitProtocol</a><'p>, </span></code><a class="srclink" href="../../../src/pyo3/class/pyasync.rs.html#21-26" title="goto source code">[src]</a></h3><h3 id="method.__aiter__" class="method"><code>fn <a href="#method.__aiter__" class="fnname">__aiter__</a>(slf: Self::<a class="type" href="../../../pyo3/class/pyasync/trait.PyAsyncAiterProtocol.html#associatedtype.Receiver" title="type pyo3::class::pyasync::PyAsyncAiterProtocol::Receiver">Receiver</a>) -> Self::<a class="type" href="../../../pyo3/class/pyasync/trait.PyAsyncAiterProtocol.html#associatedtype.Result" title="type pyo3::class::pyasync::PyAsyncAiterProtocol::Result">Result</a> <span class="where fmt-newline">where<br> Self: <a class="trait" href="../../../pyo3/class/pyasync/trait.PyAsyncAiterProtocol.html" title="trait pyo3::class::pyasync::PyAsyncAiterProtocol">PyAsyncAiterProtocol</a><'p>, </span></code><a class="srclink" href="../../../src/pyo3/class/pyasync.rs.html#28-33" title="goto source code">[src]</a></h3><h3 id="method.__anext__" class="method"><code>fn <a href="#method.__anext__" class="fnname">__anext__</a>(slf: Self::<a class="type" href="../../../pyo3/class/pyasync/trait.PyAsyncAnextProtocol.html#associatedtype.Receiver" title="type pyo3::class::pyasync::PyAsyncAnextProtocol::Receiver">Receiver</a>) -> Self::<a class="type" href="../../../pyo3/class/pyasync/trait.PyAsyncAnextProtocol.html#associatedtype.Result" title="type pyo3::class::pyasync::PyAsyncAnextProtocol::Result">Result</a> <span class="where fmt-newline">where<br> Self: <a class="trait" href="../../../pyo3/class/pyasync/trait.PyAsyncAnextProtocol.html" title="trait pyo3::class::pyasync::PyAsyncAnextProtocol">PyAsyncAnextProtocol</a><'p>, </span></code><a class="srclink" href="../../../src/pyo3/class/pyasync.rs.html#35-40" title="goto source code">[src]</a></h3><h3 id="method.__aenter__" class="method"><code>fn <a href="#method.__aenter__" class="fnname">__aenter__</a>(&'p mut self) -> Self::<a class="type" href="../../../pyo3/class/pyasync/trait.PyAsyncAenterProtocol.html#associatedtype.Result" title="type pyo3::class::pyasync::PyAsyncAenterProtocol::Result">Result</a> <span class="where fmt-newline">where<br> Self: <a class="trait" href="../../../pyo3/class/pyasync/trait.PyAsyncAenterProtocol.html" title="trait pyo3::class::pyasync::PyAsyncAenterProtocol">PyAsyncAenterProtocol</a><'p>, </span></code><a class="srclink" href="../../../src/pyo3/class/pyasync.rs.html#42-47" title="goto source code">[src]</a></h3><h3 id="method.__aexit__" class="method"><code>fn <a href="#method.__aexit__" class="fnname">__aexit__</a>(<br> &'p mut self, <br> exc_type: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self::<a class="type" href="../../../pyo3/class/pyasync/trait.PyAsyncAexitProtocol.html#associatedtype.ExcType" title="type pyo3::class::pyasync::PyAsyncAexitProtocol::ExcType">ExcType</a>>, <br> exc_value: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self::<a class="type" href="../../../pyo3/class/pyasync/trait.PyAsyncAexitProtocol.html#associatedtype.ExcValue" title="type pyo3::class::pyasync::PyAsyncAexitProtocol::ExcValue">ExcValue</a>>, <br> traceback: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self::<a class="type" href="../../../pyo3/class/pyasync/trait.PyAsyncAexitProtocol.html#associatedtype.Traceback" title="type pyo3::class::pyasync::PyAsyncAexitProtocol::Traceback">Traceback</a>><br>) -> Self::<a class="type" href="../../../pyo3/class/pyasync/trait.PyAsyncAexitProtocol.html#associatedtype.Result" title="type pyo3::class::pyasync::PyAsyncAexitProtocol::Result">Result</a> <span class="where fmt-newline">where<br> Self: <a class="trait" href="../../../pyo3/class/pyasync/trait.PyAsyncAexitProtocol.html" title="trait pyo3::class::pyasync::PyAsyncAexitProtocol">PyAsyncAexitProtocol</a><'p>, </span></code><a class="srclink" href="../../../src/pyo3/class/pyasync.rs.html#49-59" 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/pyasync/trait.PyAsyncProtocol.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>
|
||
<script src="../../../main.js"></script></body></html> |