github-actions[bot]
25 lines
5.0 KiB
HTML
25 lines
5.0 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="Interns `text` as a Python string and stores a reference to it in static storage."><title>intern in pyo3 - 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 macro"><!--[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="#">intern</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example-using-intern-to-avoid-needlessly-recreating-the-same-python-string" title="Example: Using `intern!` to avoid needlessly recreating the same Python string">Example: Using <code>intern!</code> to avoid needlessly recreating the same Python string</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>Macro <span class="macro">intern</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/sync.rs.html#410-415">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! intern {
|
|
($py: expr, $text: expr) => { ... };
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Interns <code>text</code> as a Python string and stores a reference to it in static storage.</p>
|
|
<p>A reference to the same Python string is returned on each invocation.</p>
|
|
<h2 id="example-using-intern-to-avoid-needlessly-recreating-the-same-python-string"><a class="doc-anchor" href="#example-using-intern-to-avoid-needlessly-recreating-the-same-python-string">§</a>Example: Using <code>intern!</code> to avoid needlessly recreating the same Python string</h2>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>pyo3::intern;
|
|
|
|
<span class="attr">#[pyfunction]
|
|
</span><span class="kw">fn </span>create_dict(py: Python<<span class="lifetime">'_</span>>) -> PyResult<Bound<<span class="lifetime">'_</span>, PyDict>> {
|
|
<span class="kw">let </span>dict = PyDict::new(py);
|
|
<span class="comment">// 👇 A new `PyString` is created
|
|
// for every call of this function.
|
|
</span>dict.set_item(<span class="string">"foo"</span>, <span class="number">42</span>)<span class="question-mark">?</span>;
|
|
<span class="prelude-val">Ok</span>(dict)
|
|
}
|
|
|
|
<span class="attr">#[pyfunction]
|
|
</span><span class="kw">fn </span>create_dict_faster(py: Python<<span class="lifetime">'_</span>>) -> PyResult<Bound<<span class="lifetime">'_</span>, PyDict>> {
|
|
<span class="kw">let </span>dict = PyDict::new(py);
|
|
<span class="comment">// 👇 A `PyString` is created once and reused
|
|
// for the lifetime of the program.
|
|
</span>dict.set_item(<span class="macro">intern!</span>(py, <span class="string">"foo"</span>), <span class="number">42</span>)<span class="question-mark">?</span>;
|
|
<span class="prelude-val">Ok</span>(dict)
|
|
}</code></pre></div>
|
|
</div></details></section></div></main></body></html> |