mirror of
https://github.com/fluencelabs/wasmer
synced 2025-04-25 18:32:15 +00:00
33 lines
8.9 KiB
HTML
33 lines
8.9 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 `settings` mod in crate `cranelift_codegen`."><meta name="keywords" content="rust, rustlang, rust-lang, settings"><title>cranelift_codegen::settings - 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 mod"><!--[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='../../cranelift_codegen/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Module settings</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../index.html'>cranelift_codegen</a></p><script>window.sidebarCurrent = {name: 'settings', ty: 'mod', 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 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/cranelift_codegen/settings.rs.html#1-436' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>cranelift_codegen</a>::<wbr><a class="mod" href=''>settings</a></span></h1><div class='docblock'><p>Shared settings module.</p>
|
||
<p>This module defines data structures to access the settings defined in the meta language.</p>
|
||
<p>Each settings group is translated to a <code>Flags</code> struct either in this module or in its
|
||
ISA-specific <code>settings</code> module. The struct provides individual getter methods for all of the
|
||
settings as well as computed predicate flags.</p>
|
||
<p>The <code>Flags</code> struct is immutable once it has been created. A <code>Builder</code> instance is used to
|
||
create it.</p>
|
||
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">cranelift_codegen</span>::<span class="ident">settings</span>::{<span class="self">self</span>, <span class="ident">Configurable</span>};
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">b</span> <span class="op">=</span> <span class="ident">settings</span>::<span class="ident">builder</span>();
|
||
<span class="ident">b</span>.<span class="ident">set</span>(<span class="string">"opt_level"</span>, <span class="string">"fastest"</span>);
|
||
|
||
<span class="kw">let</span> <span class="ident">f</span> <span class="op">=</span> <span class="ident">settings</span>::<span class="ident">Flags</span>::<span class="ident">new</span>(<span class="ident">b</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">f</span>.<span class="ident">opt_level</span>(), <span class="ident">settings</span>::<span class="ident">OptLevel</span>::<span class="ident">Fastest</span>);</pre></div>
|
||
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
||
<table><tr class='module-item'><td><a class="mod" href="detail/index.html" title='cranelift_codegen::settings::detail mod'>detail</a></td><td class='docblock-short'><p>Implementation details for generated code.</p>
|
||
</td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table><tr class='module-item'><td><a class="struct" href="struct.Builder.html" title='cranelift_codegen::settings::Builder struct'>Builder</a></td><td class='docblock-short'><p>Collect settings values based on a template.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Flags.html" title='cranelift_codegen::settings::Flags struct'>Flags</a></td><td class='docblock-short'><p>Flags group <code>shared</code>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.FlagsOrIsa.html" title='cranelift_codegen::settings::FlagsOrIsa struct'>FlagsOrIsa</a></td><td class='docblock-short'><p>Wrapper containing flags and optionally a <code>TargetIsa</code> trait object.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.PredicateView.html" title='cranelift_codegen::settings::PredicateView struct'>PredicateView</a></td><td class='docblock-short'><p>A reference to just the boolean predicates of a settings object.</p>
|
||
</td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
||
<table><tr class='module-item'><td><a class="enum" href="enum.OptLevel.html" title='cranelift_codegen::settings::OptLevel enum'>OptLevel</a></td><td class='docblock-short'><p>Values for <code>shared.opt_level</code>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.SetError.html" title='cranelift_codegen::settings::SetError enum'>SetError</a></td><td class='docblock-short'><p>An error produced when changing a setting.</p>
|
||
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
||
<table><tr class='module-item'><td><a class="trait" href="trait.Configurable.html" title='cranelift_codegen::settings::Configurable trait'>Configurable</a></td><td class='docblock-short'><p>A string-based configurator for settings groups.</p>
|
||
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table><tr class='module-item'><td><a class="fn" href="fn.builder.html" title='cranelift_codegen::settings::builder fn'>builder</a></td><td class='docblock-short'><p>Create a <code>settings::Builder</code> for the shared settings group.</p>
|
||
</td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
||
<table><tr class='module-item'><td><a class="type" href="type.SetResult.html" title='cranelift_codegen::settings::SetResult type'>SetResult</a></td><td class='docblock-short'><p>A result returned when changing a setting.</p>
|
||
</td></tr></table></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 = "cranelift_codegen";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |