Auto Generated Documentation
This commit is contained in:
github-actions[bot]
@@ -1,23 +1,3 @@
|
||||
<!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="Conversions between various states of Rust and Python types and their wrappers."><meta name="keywords" content="rust, rustlang, rust-lang, conversion"><title>pyo3::conversion - 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 conversion</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#traits">Traits</a></li></ul></div><p class="location"><a href="../index.html">pyo3</a></p><div id="sidebar-vars" data-name="conversion" 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 class="mod" href="">conversion</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/conversion.rs.html#3-521" title="goto source code">[src]</a></span></h1><div class="docblock"><p>Conversions between various states of Rust and Python types and their wrappers.</p>
|
||||
</div><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2>
|
||||
<table><tr class="module-item"><td><a class="trait" href="trait.AsPyPointer.html" title="pyo3::conversion::AsPyPointer trait">AsPyPointer</a></td><td class="docblock-short"><p>This trait represents that <strong>we can do zero-cost conversion from the object
|
||||
to a FFI pointer</strong>.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="trait" href="trait.FromPyObject.html" title="pyo3::conversion::FromPyObject trait">FromPyObject</a></td><td class="docblock-short"><p><code>FromPyObject</code> is implemented by various types that can be extracted from
|
||||
a Python object reference.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="trait" href="trait.FromPyPointer.html" title="pyo3::conversion::FromPyPointer trait">FromPyPointer</a></td><td class="docblock-short"><p>Raw level conversion between <code>*mut ffi::PyObject</code> and PyO3 types.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="trait" href="trait.IntoPy.html" title="pyo3::conversion::IntoPy trait">IntoPy</a></td><td class="docblock-short"><p>Similar to <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="std::convert::Into">std::convert::Into</a>, just that it requires a gil token.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="trait" href="trait.IntoPyPointer.html" title="pyo3::conversion::IntoPyPointer trait">IntoPyPointer</a></td><td class="docblock-short"><p>This trait allows retrieving the underlying FFI pointer from Python objects.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="trait" href="trait.PyTryFrom.html" title="pyo3::conversion::PyTryFrom trait">PyTryFrom</a></td><td class="docblock-short"><p>Trait implemented by Python object types that allow a checked downcast.
|
||||
If <code>T</code> implements <code>PyTryFrom</code>, we can convert <code>&PyAny</code> to <code>&T</code>.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="trait" href="trait.PyTryInto.html" title="pyo3::conversion::PyTryInto trait">PyTryInto</a></td><td class="docblock-short"><p>Trait implemented by Python object types that allow a checked downcast.
|
||||
This trait is similar to <code>std::convert::TryInto</code></p>
|
||||
</td></tr><tr class="module-item"><td><a class="trait" href="trait.ToBorrowedObject.html" title="pyo3::conversion::ToBorrowedObject trait">ToBorrowedObject</a></td><td class="docblock-short"><p>This trait has two implementations: The slow one is implemented for
|
||||
all <a href="trait.ToPyObject.html" title="ToPyObject">ToPyObject</a> and creates a new object using <a href="trait.ToPyObject.html#tymethod.to_object" title="ToPyObject::to_object">ToPyObject::to_object</a>,
|
||||
while the fast one is only implemented for AsPyPointer (we know
|
||||
that every AsPyPointer is also ToPyObject) and uses <a href="trait.AsPyPointer.html#tymethod.as_ptr" title="AsPyPointer::as_ptr()">AsPyPointer::as_ptr()</a></p>
|
||||
</td></tr><tr class="module-item"><td><a class="trait" href="trait.ToPyObject.html" title="pyo3::conversion::ToPyObject trait">ToPyObject</a></td><td class="docblock-short"><p>Conversion trait that allows various objects to be converted into <code>PyObject</code>.</p>
|
||||
</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="Defines conversions between Rust and Python types."><title>pyo3::conversion - 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 conversion</a></h2><h3><a href="#traits">Module Items</a></h3><ul class="block"><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate pyo3</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></span><h1>Module <span>conversion</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/conversion.rs.html#1-615">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Defines conversions between Rust and Python types.</p>
|
||||
</div></details><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.AsPyPointer.html" title="trait pyo3::conversion::AsPyPointer">AsPy<wbr>Pointer</a></div><div class="desc docblock-short">Returns a borrowed pointer to a Python object.</div></li><li><div class="item-name"><a class="trait" href="trait.FromPyObject.html" title="trait pyo3::conversion::FromPyObject">From<wbr>PyObject</a></div><div class="desc docblock-short">Extract a type from a Python object.</div></li><li><div class="item-name"><a class="trait" href="trait.FromPyObjectBound.html" title="trait pyo3::conversion::FromPyObjectBound">From<wbr>PyObject<wbr>Bound</a></div><div class="desc docblock-short">Expected form of <a href="trait.FromPyObject.html" title="trait pyo3::conversion::FromPyObject"><code>FromPyObject</code></a> to be used in a future PyO3 release.</div></li><li><div class="item-name"><a class="trait" href="trait.IntoPy.html" title="trait pyo3::conversion::IntoPy">IntoPy</a><wbr><span class="stab deprecated" title="">Deprecated</span></div><div class="desc docblock-short">Defines a conversion from a Rust type to a Python object.</div></li><li><div class="item-name"><a class="trait" href="trait.IntoPyObject.html" title="trait pyo3::conversion::IntoPyObject">Into<wbr>PyObject</a></div><div class="desc docblock-short">Defines a conversion from a Rust type to a Python object, which may fail.</div></li><li><div class="item-name"><a class="trait" href="trait.IntoPyObjectExt.html" title="trait pyo3::conversion::IntoPyObjectExt">Into<wbr>PyObject<wbr>Ext</a></div><div class="desc docblock-short">Convenience methods for common usages of <a href="trait.IntoPyObject.html" title="trait pyo3::conversion::IntoPyObject"><code>IntoPyObject</code></a>. Every type that implements
|
||||
<a href="trait.IntoPyObject.html" title="trait pyo3::conversion::IntoPyObject"><code>IntoPyObject</code></a> also implements this trait.</div></li><li><div class="item-name"><a class="trait" href="trait.ToPyObject.html" title="trait pyo3::conversion::ToPyObject">ToPy<wbr>Object</a><wbr><span class="stab deprecated" title="">Deprecated</span></div><div class="desc docblock-short">Conversion trait that allows various objects to be converted into <code>PyObject</code>.</div></li></ul></section></div></main></body></html>
|
||||
Reference in New Issue
Block a user