github-actions[bot]
6 lines
7.2 KiB
HTML
6 lines
7.2 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="Configuration used by PyO3 for conditional support of varying Python versions."><title>pyo3_build_config - 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_build_config" 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="../crates.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 crate"><!--[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_build_config/index.html">pyo3_<wbr>build_<wbr>config</a><span class="version">0.24.1</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>Crate <span>pyo3_build_config</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_build_config/lib.rs.html#1-383">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Configuration used by PyO3 for conditional support of varying Python versions.</p>
|
||
<p>This crate exposes functionality to be called from build scripts to simplify building crates
|
||
which depend on PyO3.</p>
|
||
<p>It used internally by the PyO3 crate’s build script to apply the same configuration.</p>
|
||
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.BuildFlags.html" title="struct pyo3_build_config::BuildFlags">Build<wbr>Flags</a></div><div class="desc docblock-short">A list of python interpreter compile-time preprocessor defines.</div></li><li><div class="item-name"><a class="struct" href="struct.CrossCompileConfig.html" title="struct pyo3_build_config::CrossCompileConfig">Cross<wbr>Compile<wbr>Config</a></div><div class="desc docblock-short">Configuration needed by PyO3 to cross-compile for a target platform.</div></li><li><div class="item-name"><a class="struct" href="struct.InterpreterConfig.html" title="struct pyo3_build_config::InterpreterConfig">Interpreter<wbr>Config</a></div><div class="desc docblock-short">Configuration needed by PyO3 to build for the correct Python implementation.</div></li><li><div class="item-name"><a class="struct" href="struct.PythonVersion.html" title="struct pyo3_build_config::PythonVersion">Python<wbr>Version</a></div></li><li><div class="item-name"><a class="struct" href="struct.Triple.html" title="struct pyo3_build_config::Triple">Triple</a></div><div class="desc docblock-short">An LLVM target “triple”. Historically such things had three fields, though
|
||
they’ve added additional fields over time.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.BuildFlag.html" title="enum pyo3_build_config::BuildFlag">Build<wbr>Flag</a></div></li><li><div class="item-name"><a class="enum" href="enum.PythonImplementation.html" title="enum pyo3_build_config::PythonImplementation">Python<wbr>Implementation</a></div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.add_extension_module_link_args.html" title="fn pyo3_build_config::add_extension_module_link_args">add_<wbr>extension_<wbr>module_<wbr>link_<wbr>args</a></div><div class="desc docblock-short">Adds linker arguments suitable for PyO3’s <code>extension-module</code> feature.</div></li><li><div class="item-name"><a class="fn" href="fn.add_python_framework_link_args.html" title="fn pyo3_build_config::add_python_framework_link_args">add_<wbr>python_<wbr>framework_<wbr>link_<wbr>args</a></div><div class="desc docblock-short">Adds linker arguments suitable for linking against the Python framework on macOS.</div></li><li><div class="item-name"><a class="fn" href="fn.cross_compiling_from_to.html" title="fn pyo3_build_config::cross_compiling_from_to">cross_<wbr>compiling_<wbr>from_<wbr>to</a></div><div class="desc docblock-short">Detect whether we are cross compiling and return an assembled CrossCompileConfig if so.</div></li><li><div class="item-name"><a class="fn" href="fn.find_all_sysconfigdata.html" title="fn pyo3_build_config::find_all_sysconfigdata">find_<wbr>all_<wbr>sysconfigdata</a></div><div class="desc docblock-short">Finds <code>_sysconfigdata*.py</code> files for detected Python interpreters.</div></li><li><div class="item-name"><a class="fn" href="fn.get.html" title="fn pyo3_build_config::get">get</a></div><div class="desc docblock-short">Loads the configuration determined from the build environment.</div></li><li><div class="item-name"><a class="fn" href="fn.parse_sysconfigdata.html" title="fn pyo3_build_config::parse_sysconfigdata">parse_<wbr>sysconfigdata</a></div><div class="desc docblock-short">Parse sysconfigdata file</div></li><li><div class="item-name"><a class="fn" href="fn.use_pyo3_cfgs.html" title="fn pyo3_build_config::use_pyo3_cfgs">use_<wbr>pyo3_<wbr>cfgs</a></div><div class="desc docblock-short">Adds all the <a href="index.html"><code>#[cfg]</code> flags</a> to the current compilation.</div></li></ul></section></div></main></body></html> |