Auto Generated Documentation
This commit is contained in:
@@ -1,17 +1,17 @@
|
||||
<!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="Returns the function that is called in the C-FFI."><meta name="keywords" content="rust, rustlang, rust-lang, raw_pycfunction"><title>pyo3::raw_pycfunction - 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="Returns the function that is called in the C-FFI."><meta name="keywords" content="rust, rustlang, rust-lang, raw_pycfunction"><title>raw_pycfunction in pyo3 - 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 macro"><!--[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><div class="sidebar-elems"><p class="location"><a href="index.html">pyo3</a></p><div id="sidebar-vars" data-name="raw_pycfunction" data-ty="macro" 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">Macro <a href="index.html">pyo3</a>::<wbr><a class="macro" href="">raw_pycfunction</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/lib.rs.html#258-262" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><div class="example-wrap"><pre class="rust macro">
|
||||
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">raw_pycfunction</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 macro"><!--[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><div class="sidebar-elems"><p class="location"><a href="index.html">pyo3</a></p><div id="sidebar-vars" data-name="raw_pycfunction" data-ty="macro" 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">Macro <a href="index.html">pyo3</a>::<wbr><a class="macro" href="">raw_pycfunction</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/lib.rs.html#258-262" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><div class="example-wrap"><pre class="rust macro">
|
||||
<span class="macro">macro_rules!</span> <span class="ident">raw_pycfunction</span> {
|
||||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">function_name</span>: <span class="ident">ident</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||||
}</pre></div>
|
||||
</div><div class="docblock"><p>Returns the function that is called in the C-FFI.</p>
|
||||
<p>Use this together with <code>#[pyfunction]</code> and <a href="../pyo3/types/struct.PyCFunction.html" title="types::PyCFunction">types::PyCFunction</a>.</p>
|
||||
<p>Use this together with <code>#[pyfunction]</code> and <a href="types/struct.PyCFunction.html" title="types::PyCFunction">types::PyCFunction</a>.</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">types</span>::<span class="ident">PyCFunction</span>;
|
||||
<span class="kw">use</span> <span class="ident">pyo3</span>::<span class="ident">raw_pycfunction</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::types::PyCFunction</span>;
|
||||
<span class="kw">use</span> <span class="ident">pyo3::raw_pycfunction</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">pyfunction</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">some_fun</span>() <span class="op">-</span><span class="op">></span> <span class="ident">PyResult</span><span class="op"><</span>()<span class="op">></span> {
|
||||
@@ -20,11 +20,11 @@
|
||||
|
||||
<span class="attribute">#[<span class="ident">pymodule</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">module</span>(<span class="ident">_py</span>: <span class="ident">Python</span>, <span class="ident">module</span>: <span class="kw-2">&</span><span class="ident">PyModule</span>) <span class="op">-</span><span class="op">></span> <span class="ident">PyResult</span><span class="op"><</span>()<span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="ident">ffi_wrapper_fun</span> <span class="op">=</span> <span class="macro">raw_pycfunction</span><span class="macro">!</span>(<span class="ident">some_fun</span>);
|
||||
<span class="kw">let</span> <span class="ident">ffi_wrapper_fun</span> <span class="op">=</span> <span class="macro">raw_pycfunction!</span>(<span class="ident">some_fun</span>);
|
||||
<span class="kw">let</span> <span class="ident">docs</span> <span class="op">=</span> <span class="string">"Some documentation string with null-termination\0"</span>;
|
||||
<span class="kw">let</span> <span class="ident">py_cfunction</span> <span class="op">=</span>
|
||||
<span class="ident">PyCFunction</span>::<span class="ident">new_with_keywords</span>(<span class="ident">ffi_wrapper_fun</span>, <span class="string">"function_name"</span>, <span class="ident">docs</span>, <span class="ident">module</span>.<span class="ident">into</span>())<span class="question-mark">?</span>;
|
||||
<span class="ident">PyCFunction::new_with_keywords</span>(<span class="ident">ffi_wrapper_fun</span>, <span class="string">"function_name"</span>, <span class="ident">docs</span>, <span class="ident">module</span>.<span class="ident">into</span>())<span class="question-mark">?</span>;
|
||||
<span class="ident">module</span>.<span class="ident">add_function</span>(<span class="ident">py_cfunction</span>)
|
||||
}</pre></div>
|
||||
</div></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></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