github-actions[bot]
20 lines
11 KiB
HTML
20 lines
11 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="Implementation of functionality for `PyMappingProxy`."><title>PyMappingProxyMethods in pyo3::prelude - 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="#">PyMapping<wbr>Proxy<wbr>Methods</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.as_mapping" title="as_mapping">as_mapping</a></li><li><a href="#tymethod.is_empty" title="is_empty">is_empty</a></li><li><a href="#tymethod.items" title="items">items</a></li><li><a href="#tymethod.keys" title="keys">keys</a></li><li><a href="#tymethod.try_iter" title="try_iter">try_iter</a></li><li><a href="#tymethod.values" title="values">values</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In pyo3::<wbr>prelude</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">prelude</a></span><h1>Trait <span class="trait">PyMappingProxyMethods</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/types/mappingproxy.rs.html#48-67">Source</a> </span></div><pre class="rust item-decl"><code>pub trait PyMappingProxyMethods<'py, 'a>: Sealed {
|
|
// Required methods
|
|
fn <a href="#tymethod.is_empty" class="fn">is_empty</a>(&self) -> <a class="type" href="../type.PyResult.html" title="type pyo3::PyResult">PyResult</a><<a class="primitive" href="https://doc.rust-lang.org/1.85.1/std/primitive.bool.html">bool</a>>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.keys" class="fn">keys</a>(&self) -> <a class="type" href="../type.PyResult.html" title="type pyo3::PyResult">PyResult</a><<a class="struct" href="../struct.Bound.html" title="struct pyo3::Bound">Bound</a><'py, <a class="struct" href="../types/struct.PyList.html" title="struct pyo3::types::PyList">PyList</a>>>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.values" class="fn">values</a>(&self) -> <a class="type" href="../type.PyResult.html" title="type pyo3::PyResult">PyResult</a><<a class="struct" href="../struct.Bound.html" title="struct pyo3::Bound">Bound</a><'py, <a class="struct" href="../types/struct.PyList.html" title="struct pyo3::types::PyList">PyList</a>>>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.items" class="fn">items</a>(&self) -> <a class="type" href="../type.PyResult.html" title="type pyo3::PyResult">PyResult</a><<a class="struct" href="../struct.Bound.html" title="struct pyo3::Bound">Bound</a><'py, <a class="struct" href="../types/struct.PyList.html" title="struct pyo3::types::PyList">PyList</a>>>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.as_mapping" class="fn">as_mapping</a>(&self) -> &<a class="struct" href="../struct.Bound.html" title="struct pyo3::Bound">Bound</a><'py, <a class="struct" href="../types/struct.PyMapping.html" title="struct pyo3::types::PyMapping">PyMapping</a>>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.try_iter" class="fn">try_iter</a>(&'a self) -> <a class="type" href="../type.PyResult.html" title="type pyo3::PyResult">PyResult</a><BoundMappingProxyIterator<'py, 'a>>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Implementation of functionality for <a href="../types/struct.PyMappingProxy.html" title="struct pyo3::types::PyMappingProxy"><code>PyMappingProxy</code></a>.</p>
|
|
<p>These methods are defined for the <code>Bound<'py, PyMappingProxy></code> smart pointer, so to use method call
|
|
syntax these methods are separated into a trait, because stable Rust does not yet support
|
|
<code>arbitrary_self_types</code>.</p>
|
|
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.is_empty" class="method"><a class="src rightside" href="../../src/pyo3/types/mappingproxy.rs.html#50">Source</a><h4 class="code-header">fn <a href="#tymethod.is_empty" class="fn">is_empty</a>(&self) -> <a class="type" href="../type.PyResult.html" title="type pyo3::PyResult">PyResult</a><<a class="primitive" href="https://doc.rust-lang.org/1.85.1/std/primitive.bool.html">bool</a>></h4></section></summary><div class="docblock"><p>Checks if the mappingproxy is empty, i.e. <code>len(self) == 0</code>.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.keys" class="method"><a class="src rightside" href="../../src/pyo3/types/mappingproxy.rs.html#53">Source</a><h4 class="code-header">fn <a href="#tymethod.keys" class="fn">keys</a>(&self) -> <a class="type" href="../type.PyResult.html" title="type pyo3::PyResult">PyResult</a><<a class="struct" href="../struct.Bound.html" title="struct pyo3::Bound">Bound</a><'py, <a class="struct" href="../types/struct.PyList.html" title="struct pyo3::types::PyList">PyList</a>>></h4></section></summary><div class="docblock"><p>Returns a list containing all keys in the mapping.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.values" class="method"><a class="src rightside" href="../../src/pyo3/types/mappingproxy.rs.html#56">Source</a><h4 class="code-header">fn <a href="#tymethod.values" class="fn">values</a>(&self) -> <a class="type" href="../type.PyResult.html" title="type pyo3::PyResult">PyResult</a><<a class="struct" href="../struct.Bound.html" title="struct pyo3::Bound">Bound</a><'py, <a class="struct" href="../types/struct.PyList.html" title="struct pyo3::types::PyList">PyList</a>>></h4></section></summary><div class="docblock"><p>Returns a list containing all values in the mapping.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.items" class="method"><a class="src rightside" href="../../src/pyo3/types/mappingproxy.rs.html#59">Source</a><h4 class="code-header">fn <a href="#tymethod.items" class="fn">items</a>(&self) -> <a class="type" href="../type.PyResult.html" title="type pyo3::PyResult">PyResult</a><<a class="struct" href="../struct.Bound.html" title="struct pyo3::Bound">Bound</a><'py, <a class="struct" href="../types/struct.PyList.html" title="struct pyo3::types::PyList">PyList</a>>></h4></section></summary><div class="docblock"><p>Returns a list of tuples of all (key, value) pairs in the mapping.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.as_mapping" class="method"><a class="src rightside" href="../../src/pyo3/types/mappingproxy.rs.html#62">Source</a><h4 class="code-header">fn <a href="#tymethod.as_mapping" class="fn">as_mapping</a>(&self) -> &<a class="struct" href="../struct.Bound.html" title="struct pyo3::Bound">Bound</a><'py, <a class="struct" href="../types/struct.PyMapping.html" title="struct pyo3::types::PyMapping">PyMapping</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> cast as a <code>PyMapping</code>.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.try_iter" class="method"><a class="src rightside" href="../../src/pyo3/types/mappingproxy.rs.html#66">Source</a><h4 class="code-header">fn <a href="#tymethod.try_iter" class="fn">try_iter</a>(&'a self) -> <a class="type" href="../type.PyResult.html" title="type pyo3::PyResult">PyResult</a><BoundMappingProxyIterator<'py, 'a>></h4></section></summary><div class="docblock"><p>Takes an object and returns an iterator for it. Returns an error if the object is not
|
|
iterable.</p>
|
|
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-PyMappingProxyMethods%3C'py,+'a%3E-for-Bound%3C'py,+PyMappingProxy%3E" class="impl"><a class="src rightside" href="../../src/pyo3/types/mappingproxy.rs.html#69-111">Source</a><a href="#impl-PyMappingProxyMethods%3C'py,+'a%3E-for-Bound%3C'py,+PyMappingProxy%3E" class="anchor">§</a><h3 class="code-header">impl<'py, 'a> <a class="trait" href="trait.PyMappingProxyMethods.html" title="trait pyo3::prelude::PyMappingProxyMethods">PyMappingProxyMethods</a><'py, 'a> for <a class="struct" href="../struct.Bound.html" title="struct pyo3::Bound">Bound</a><'py, <a class="struct" href="../types/struct.PyMappingProxy.html" title="struct pyo3::types::PyMappingProxy">PyMappingProxy</a>></h3></section></div><script src="../../trait.impl/pyo3/types/mappingproxy/trait.PyMappingProxyMethods.js" async></script></section></div></main></body></html> |