wasmer/rustdoc/cranelift_codegen/ir/trait.ProgramOrder.html
2019-09-06 15:57:44 -07:00

18 lines
11 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `ProgramOrder` trait in crate `cranelift_codegen`."><meta name="keywords" content="rust, rustlang, rust-lang, ProgramOrder"><title>cranelift_codegen::ir::ProgramOrder - 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">&#9776;</div><a href='../../cranelift_codegen/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait ProgramOrder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.cmp">cmp</a><a href="#tymethod.is_ebb_gap">is_ebb_gap</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>cranelift_codegen</a>::<wbr><a href='index.html'>ir</a></p><script>window.sidebarCurrent = {name: 'ProgramOrder', 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 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/cranelift_codegen/ir/progpoint.rs.html#127-144' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>cranelift_codegen</a>::<wbr><a href='index.html'>ir</a>::<wbr><a class="trait" href=''>ProgramOrder</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait ProgramOrder {
fn <a href='#tymethod.cmp' class='fnname'>cmp</a>&lt;A, B&gt;(&amp;self, a: A, b: B) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a><br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="../../cranelift_codegen/ir/enum.ExpandedProgramPoint.html" title="enum cranelift_codegen::ir::ExpandedProgramPoint">ExpandedProgramPoint</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="../../cranelift_codegen/ir/enum.ExpandedProgramPoint.html" title="enum cranelift_codegen::ir::ExpandedProgramPoint">ExpandedProgramPoint</a>&gt;</span>;
<div class='item-spacer'></div> fn <a href='#tymethod.is_ebb_gap' class='fnname'>is_ebb_gap</a>(&amp;self, inst: <a class="struct" href="../../cranelift_codegen/ir/entities/struct.Inst.html" title="struct cranelift_codegen::ir::entities::Inst">Inst</a>, ebb: <a class="struct" href="../../cranelift_codegen/ir/entities/struct.Ebb.html" title="struct cranelift_codegen::ir::entities::Ebb">Ebb</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
}</pre></div><div class='docblock'><p>Context for ordering program points.</p>
<p><code>ProgramPoint</code> objects don't carry enough information to be ordered independently, they need a
context providing the program order.</p>
</div>
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.cmp' class='method'><code id='cmp.v'>fn <a href='#tymethod.cmp' class='fnname'>cmp</a>&lt;A, B&gt;(&amp;self, a: A, b: B) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="../../cranelift_codegen/ir/enum.ExpandedProgramPoint.html" title="enum cranelift_codegen::ir::ExpandedProgramPoint">ExpandedProgramPoint</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="../../cranelift_codegen/ir/enum.ExpandedProgramPoint.html" title="enum cranelift_codegen::ir::ExpandedProgramPoint">ExpandedProgramPoint</a>&gt;,&nbsp;</span></code></h3><div class='docblock'><p>Compare the program points <code>a</code> and <code>b</code> relative to this program order.</p>
<p>Return <code>Less</code> if <code>a</code> appears in the program before <code>b</code>.</p>
<p>This is declared as a generic such that it can be called with <code>Inst</code> and <code>Ebb</code> arguments
directly. Depending on the implementation, there is a good chance performance will be
improved for those cases where the type of either argument is known statically.</p>
</div><h3 id='tymethod.is_ebb_gap' class='method'><code id='is_ebb_gap.v'>fn <a href='#tymethod.is_ebb_gap' class='fnname'>is_ebb_gap</a>(&amp;self, inst: <a class="struct" href="../../cranelift_codegen/ir/entities/struct.Inst.html" title="struct cranelift_codegen::ir::entities::Inst">Inst</a>, ebb: <a class="struct" href="../../cranelift_codegen/ir/entities/struct.Ebb.html" title="struct cranelift_codegen::ir::entities::Ebb">Ebb</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Is the range from <code>inst</code> to <code>ebb</code> just the gap between consecutive EBBs?</p>
<p>This returns true if <code>inst</code> is the terminator in the EBB immediately before <code>ebb</code>.</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'><h3 id='impl-ProgramOrder' class='impl'><code class='in-band'>impl ProgramOrder for <a class="struct" href="../../cranelift_codegen/ir/layout/struct.Layout.html" title="struct cranelift_codegen::ir::layout::Layout">Layout</a></code><a href='#impl-ProgramOrder' class='anchor'></a><a class='srclink' href='../../src/cranelift_codegen/ir/layout.rs.html#113-130' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.cmp' class="method hidden"><code id='cmp.v-1'>fn <a href='#method.cmp' class='fnname'>cmp</a>&lt;A, B&gt;(&amp;self, a: A, b: B) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="../../cranelift_codegen/ir/enum.ExpandedProgramPoint.html" title="enum cranelift_codegen::ir::ExpandedProgramPoint">ExpandedProgramPoint</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="../../cranelift_codegen/ir/enum.ExpandedProgramPoint.html" title="enum cranelift_codegen::ir::ExpandedProgramPoint">ExpandedProgramPoint</a>&gt;,&nbsp;</span></code><a class='srclink' href='../../src/cranelift_codegen/ir/layout.rs.html#114-122' title='goto source code'>[src]</a></h4><h4 id='method.is_ebb_gap' class="method hidden"><code id='is_ebb_gap.v-1'>fn <a href='#method.is_ebb_gap' class='fnname'>is_ebb_gap</a>(&amp;self, inst: <a class="struct" href="../../cranelift_codegen/ir/entities/struct.Inst.html" title="struct cranelift_codegen::ir::entities::Inst">Inst</a>, ebb: <a class="struct" href="../../cranelift_codegen/ir/entities/struct.Ebb.html" title="struct cranelift_codegen::ir::entities::Ebb">Ebb</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/cranelift_codegen/ir/layout.rs.html#124-129' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
src="../../implementors/cranelift_codegen/ir/trait.ProgramOrder.js">
</script></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>&#9166;</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>