github-actions[bot]
12 lines
7.4 KiB
HTML
12 lines
7.4 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="Extension trait for `std::sync::Mutex` which helps avoid deadlocks between the Python interpreter and acquiring the `Mutex`."><title>MutexExt in pyo3::sync - 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="#">Mutex<wbr>Ext</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.lock_py_attached" title="lock_py_attached">lock_py_attached</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-MutexExt%3CT%3E-for-Mutex%3CT%3E" title="Mutex<T>">Mutex<T></a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In pyo3::<wbr>sync</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">sync</a></span><h1>Trait <span class="trait">MutexExt</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#568-580">Source</a> </span></div><pre class="rust item-decl"><code>pub trait MutexExt<T>: Sealed {
|
|
// Required method
|
|
fn <a href="#tymethod.lock_py_attached" class="fn">lock_py_attached</a>(&self, py: <a class="struct" href="../marker/struct.Python.html" title="struct pyo3::marker::Python">Python</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.85.1/std/sync/poison/type.LockResult.html" title="type std::sync::poison::LockResult">LockResult</a><<a class="struct" href="https://doc.rust-lang.org/1.85.1/std/sync/poison/mutex/struct.MutexGuard.html" title="struct std::sync::poison::mutex::MutexGuard">MutexGuard</a><'_, T>>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Extension trait for <a href="https://doc.rust-lang.org/1.85.1/std/sync/poison/mutex/struct.Mutex.html" title="struct std::sync::poison::mutex::Mutex"><code>std::sync::Mutex</code></a> which helps avoid deadlocks between
|
|
the Python interpreter and acquiring the <code>Mutex</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.lock_py_attached" class="method"><a class="src rightside" href="../../src/pyo3/sync.rs.html#576-579">Source</a><h4 class="code-header">fn <a href="#tymethod.lock_py_attached" class="fn">lock_py_attached</a>(&self, py: <a class="struct" href="../marker/struct.Python.html" title="struct pyo3::marker::Python">Python</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.85.1/std/sync/poison/type.LockResult.html" title="type std::sync::poison::LockResult">LockResult</a><<a class="struct" href="https://doc.rust-lang.org/1.85.1/std/sync/poison/mutex/struct.MutexGuard.html" title="struct std::sync::poison::mutex::MutexGuard">MutexGuard</a><'_, T>></h4></section></summary><div class="docblock"><p>Lock this <code>Mutex</code> in a manner that cannot deadlock with the Python interpreter.</p>
|
|
<p>Before attempting to lock the mutex, this function detaches from the
|
|
Python runtime. When the lock is acquired, it re-attaches to the Python
|
|
runtime before returning the <code>LockResult</code>. This avoids deadlocks between
|
|
the GIL and other global synchronization events triggered by the Python
|
|
interpreter.</p>
|
|
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-MutexExt%3CT%3E-for-Mutex%3CT%3E" class="impl"><a class="src rightside" href="../../src/pyo3/sync.rs.html#615-639">Source</a><a href="#impl-MutexExt%3CT%3E-for-Mutex%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="trait.MutexExt.html" title="trait pyo3::sync::MutexExt">MutexExt</a><T> for <a class="struct" href="https://doc.rust-lang.org/1.85.1/std/sync/poison/mutex/struct.Mutex.html" title="struct std::sync::poison::mutex::Mutex">Mutex</a><T></h3></section></summary><div class="impl-items"><section id="method.lock_py_attached" class="method trait-impl"><a class="src rightside" href="../../src/pyo3/sync.rs.html#616-638">Source</a><a href="#method.lock_py_attached" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.lock_py_attached" class="fn">lock_py_attached</a>(&self, _py: <a class="struct" href="../marker/struct.Python.html" title="struct pyo3::marker::Python">Python</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.85.1/std/sync/poison/type.LockResult.html" title="type std::sync::poison::LockResult">LockResult</a><<a class="struct" href="https://doc.rust-lang.org/1.85.1/std/sync/poison/mutex/struct.MutexGuard.html" title="struct std::sync::poison::mutex::MutexGuard">MutexGuard</a><'_, T>></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/pyo3/sync/trait.MutexExt.js" data-ignore-extern-crates="std" async></script></section></div></main></body></html> |