| <!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 `is_x86_feature_detected` macro in crate `std_detect`."><meta name="keywords" content="rust, rustlang, rust-lang, is_x86_feature_detected"><title>std_detect::is_x86_feature_detected - 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 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">☰</div><a href='../std_detect/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='index.html'>std_detect</a></p><script>window.sidebarCurrent = {name: 'is_x86_feature_detected', ty: 'macro', 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 js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" 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 class='since' title='Stable since Rust version 1.27.0'>1.27.0</span><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/std_detect/detect/arch/x86.rs.html#85-253' title='goto source code'>[src]</a></span><span class='in-band'>Macro <a href='index.html'>std_detect</a>::<wbr><a class="macro" href=''>is_x86_feature_detected</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">is_x86_feature_detected</span> { |
| (<span class="string">"aes"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"pclmulqdq"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"rdrand"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"rdseed"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"tsc"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"mmx"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"sse"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"sse2"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"sse3"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"ssse3"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"sse4.1"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"sse4.2"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"sse4a"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"sha"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"avx"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"avx2"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"avx512f"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"avx512cd"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"avx512er"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"avx512pf"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"avx512bw"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"avx512dq"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"avx512vl"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"avx512ifma"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"avx512vbmi"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"avx512vpopcntdq"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"f16c"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"fma"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"bmi1"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"bmi2"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"abm"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"lzcnt"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"tbm"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"popcnt"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"fxsr"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"xsave"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"xsaveopt"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"xsaves"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"xsavec"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"cmpxchg16b"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"adx"</span>) <span class="op">=></span> { ... }; |
| (<span class="string">"rtm"</span>) <span class="op">=></span> { ... }; |
| (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span>:<span class="ident">tt</span>,) <span class="op">=></span> { ... }; |
| (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</span>:<span class="ident">tt</span>) <span class="op">=></span> { ... }; |
| }</pre></div> |
| </div><div class='docblock'><p>A macro to test at <em>runtime</em> whether a CPU feature is available on |
| x86/x86-64 platforms.</p> |
| <p>This macro is provided in the standard library and will detect at runtime |
| whether the specified CPU feature is detected. This does <strong>not</strong> resolve at |
| compile time unless the specified feature is already enabled for the entire |
| crate. Runtime detection currently relies mostly on the <code>cpuid</code> instruction.</p> |
| <p>This macro only takes one argument which is a string literal of the feature |
| being tested for. The feature names supported are the lowercase versions of |
| the ones defined by Intel in <a href="https://software.intel.com/sites/landingpage/IntrinsicsGuide">their documentation</a>.</p> |
| <h2 id="supported-arguments" class="section-header"><a href="#supported-arguments">Supported arguments</a></h2> |
| <p>This macro supports the same names that <code>#[target_feature]</code> supports. Unlike |
| <code>#[target_feature]</code>, however, this macro does not support names separated |
| with a comma. Instead testing for multiple features must be done through |
| separate macro invocations for now.</p> |
| <p>Supported arguments are:</p> |
| <ul> |
| <li><code>"aes"</code></li> |
| <li><code>"pclmulqdq"</code></li> |
| <li><code>"rdrand"</code></li> |
| <li><code>"rdseed"</code></li> |
| <li><code>"tsc"</code></li> |
| <li><code>"mmx"</code></li> |
| <li><code>"sse"</code></li> |
| <li><code>"sse2"</code></li> |
| <li><code>"sse3"</code></li> |
| <li><code>"ssse3"</code></li> |
| <li><code>"sse4.1"</code></li> |
| <li><code>"sse4.2"</code></li> |
| <li><code>"sse4a"</code></li> |
| <li><code>"sha"</code></li> |
| <li><code>"avx"</code></li> |
| <li><code>"avx2"</code></li> |
| <li><code>"avx512f"</code></li> |
| <li><code>"avx512cd"</code></li> |
| <li><code>"avx512er"</code></li> |
| <li><code>"avx512pf"</code></li> |
| <li><code>"avx512bw"</code></li> |
| <li><code>"avx512dq"</code></li> |
| <li><code>"avx512vl"</code></li> |
| <li><code>"avx512ifma"</code></li> |
| <li><code>"avx512vbmi"</code></li> |
| <li><code>"avx512vpopcntdq"</code></li> |
| <li><code>"f16c"</code></li> |
| <li><code>"fma"</code></li> |
| <li><code>"bmi1"</code></li> |
| <li><code>"bmi2"</code></li> |
| <li><code>"abm"</code></li> |
| <li><code>"lzcnt"</code></li> |
| <li><code>"tbm"</code></li> |
| <li><code>"popcnt"</code></li> |
| <li><code>"fxsr"</code></li> |
| <li><code>"xsave"</code></li> |
| <li><code>"xsaveopt"</code></li> |
| <li><code>"xsaves"</code></li> |
| <li><code>"xsavec"</code></li> |
| <li><code>"adx"</code></li> |
| <li><code>"rtm"</code></li> |
| </ul> |
| </div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "std_detect";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
