18 lines
5.6 KiB
HTML
18 lines
5.6 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="API documentation for the Rust `GetThreadId` trait in crate `lock_api`."><meta name="keywords" content="rust, rustlang, rust-lang, GetThreadId"><title>lock_api::GetThreadId - 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="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[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">☰</div><a href='../lock_api/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait GetThreadId</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-const">Associated Constants</a><div class="sidebar-links"><a href="#associatedconstant.INIT">INIT</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.nonzero_thread_id">nonzero_thread_id</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>lock_api</a></p><script>window.sidebarCurrent = {name: 'GetThreadId', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></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><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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/lock_api/remutex.rs.html#38-48' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>lock_api</a>::<wbr><a class="trait" href=''>GetThreadId</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub unsafe trait GetThreadId {
|
||
const <a href='#associatedconstant.INIT' class="constant"><b>INIT</b></a>: Self;
|
||
|
||
fn <a href='#tymethod.nonzero_thread_id' class='fnname'>nonzero_thread_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroUsize.html" title="struct core::num::NonZeroUsize">NonZeroUsize</a>;
|
||
}</pre></div><div class='docblock'><p>Helper trait which returns a non-zero thread ID.</p>
|
||
<p>The simplest way to implement this trait is to return the address of a
|
||
thread-local variable.</p>
|
||
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
|
||
<p>Implementations of this trait must ensure that no two active threads share
|
||
the same thread ID. However the ID of a thread that has exited can be
|
||
re-used since that thread is no longer active.</p>
|
||
</div>
|
||
<h2 id='associated-const' class='small-section-header'>Associated Constants<a href='#associated-const' class='anchor'></a></h2><div class='methods'><h3 id='associatedconstant.INIT' class='method'><code id='INIT.v'>const <a href='#associatedconstant.INIT' class="constant"><b>INIT</b></a>: Self</code></h3><div class='docblock'><p>Initial value.</p>
|
||
</div></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.nonzero_thread_id' class='method'><code id='nonzero_thread_id.v'>fn <a href='#tymethod.nonzero_thread_id' class='fnname'>nonzero_thread_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.NonZeroUsize.html" title="struct core::num::NonZeroUsize">NonZeroUsize</a></code></h3><div class='docblock'><p>Returns a non-zero thread ID which identifies the current thread of
|
||
execution.</p>
|
||
</div></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'></div><span class='loading-content'>Loading content...</span><script type="text/javascript" src="../implementors/lock_api/trait.GetThreadId.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "lock_api";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |