mirror of
https://github.com/fluencelabs/wasmer
synced 2025-04-26 02:42:18 +00:00
33 lines
19 KiB
HTML
33 lines
19 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 `CodeSink` trait in crate `cranelift_codegen`."><meta name="keywords" content="rust, rustlang, rust-lang, CodeSink"><title>cranelift_codegen::binemit::CodeSink - 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='../../cranelift_codegen/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait CodeSink</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.begin_jumptables">begin_jumptables</a><a href="#tymethod.begin_rodata">begin_rodata</a><a href="#tymethod.end_codegen">end_codegen</a><a href="#tymethod.offset">offset</a><a href="#tymethod.put1">put1</a><a href="#tymethod.put2">put2</a><a href="#tymethod.put4">put4</a><a href="#tymethod.put8">put8</a><a href="#tymethod.reloc_ebb">reloc_ebb</a><a href="#tymethod.reloc_external">reloc_external</a><a href="#tymethod.reloc_jt">reloc_jt</a><a href="#tymethod.trap">trap</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'>binemit</a></p><script>window.sidebarCurrent = {name: 'CodeSink', 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'>−</span>]</a></span><a class='srclink' href='../../src/cranelift_codegen/binemit/mod.rs.html#105-141' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>cranelift_codegen</a>::<wbr><a href='index.html'>binemit</a>::<wbr><a class="trait" href=''>CodeSink</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait CodeSink {
|
||
fn <a href='#tymethod.offset' class='fnname'>offset</a>(&self) -> <a class="type" href="../../cranelift_codegen/binemit/type.CodeOffset.html" title="type cranelift_codegen::binemit::CodeOffset">CodeOffset</a>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.put1' class='fnname'>put1</a>(&mut self, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.put2' class='fnname'>put2</a>(&mut self, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.put4' class='fnname'>put4</a>(&mut self, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.put8' class='fnname'>put8</a>(&mut self, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.reloc_ebb' class='fnname'>reloc_ebb</a>(&mut self, _: <a class="enum" href="../../cranelift_codegen/binemit/enum.Reloc.html" title="enum cranelift_codegen::binemit::Reloc">Reloc</a>, _: <a class="type" href="../../cranelift_codegen/binemit/type.CodeOffset.html" title="type cranelift_codegen::binemit::CodeOffset">CodeOffset</a>);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.reloc_external' class='fnname'>reloc_external</a>(&mut self, _: <a class="enum" href="../../cranelift_codegen/binemit/enum.Reloc.html" title="enum cranelift_codegen::binemit::Reloc">Reloc</a>, _: &<a class="enum" href="../../cranelift_codegen/ir/enum.ExternalName.html" title="enum cranelift_codegen::ir::ExternalName">ExternalName</a>, _: <a class="type" href="../../cranelift_codegen/binemit/type.Addend.html" title="type cranelift_codegen::binemit::Addend">Addend</a>);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.reloc_jt' class='fnname'>reloc_jt</a>(&mut self, _: <a class="enum" href="../../cranelift_codegen/binemit/enum.Reloc.html" title="enum cranelift_codegen::binemit::Reloc">Reloc</a>, _: <a class="struct" href="../../cranelift_codegen/ir/entities/struct.JumpTable.html" title="struct cranelift_codegen::ir::entities::JumpTable">JumpTable</a>);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.trap' class='fnname'>trap</a>(&mut self, _: <a class="enum" href="../../cranelift_codegen/ir/enum.TrapCode.html" title="enum cranelift_codegen::ir::TrapCode">TrapCode</a>, _: <a class="struct" href="../../cranelift_codegen/ir/struct.SourceLoc.html" title="struct cranelift_codegen::ir::SourceLoc">SourceLoc</a>);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.begin_jumptables' class='fnname'>begin_jumptables</a>(&mut self);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.begin_rodata' class='fnname'>begin_rodata</a>(&mut self);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.end_codegen' class='fnname'>end_codegen</a>(&mut self);
|
||
}</pre></div><div class='docblock'><p>Abstract interface for adding bytes to the code segment.</p>
|
||
<p>A <code>CodeSink</code> will receive all of the machine code for a function. It also accepts relocations
|
||
which are locations in the code section that need to be fixed up when linking.</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.offset' class='method'><code id='offset.v'>fn <a href='#tymethod.offset' class='fnname'>offset</a>(&self) -> <a class="type" href="../../cranelift_codegen/binemit/type.CodeOffset.html" title="type cranelift_codegen::binemit::CodeOffset">CodeOffset</a></code></h3><div class='docblock'><p>Get the current position.</p>
|
||
</div><h3 id='tymethod.put1' class='method'><code id='put1.v'>fn <a href='#tymethod.put1' class='fnname'>put1</a>(&mut self, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>)</code></h3><div class='docblock'><p>Add 1 byte to the code section.</p>
|
||
</div><h3 id='tymethod.put2' class='method'><code id='put2.v'>fn <a href='#tymethod.put2' class='fnname'>put2</a>(&mut self, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>)</code></h3><div class='docblock'><p>Add 2 bytes to the code section.</p>
|
||
</div><h3 id='tymethod.put4' class='method'><code id='put4.v'>fn <a href='#tymethod.put4' class='fnname'>put4</a>(&mut self, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>)</code></h3><div class='docblock'><p>Add 4 bytes to the code section.</p>
|
||
</div><h3 id='tymethod.put8' class='method'><code id='put8.v'>fn <a href='#tymethod.put8' class='fnname'>put8</a>(&mut self, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>)</code></h3><div class='docblock'><p>Add 8 bytes to the code section.</p>
|
||
</div><h3 id='tymethod.reloc_ebb' class='method'><code id='reloc_ebb.v'>fn <a href='#tymethod.reloc_ebb' class='fnname'>reloc_ebb</a>(&mut self, _: <a class="enum" href="../../cranelift_codegen/binemit/enum.Reloc.html" title="enum cranelift_codegen::binemit::Reloc">Reloc</a>, _: <a class="type" href="../../cranelift_codegen/binemit/type.CodeOffset.html" title="type cranelift_codegen::binemit::CodeOffset">CodeOffset</a>)</code></h3><div class='docblock'><p>Add a relocation referencing an EBB at the current offset.</p>
|
||
</div><h3 id='tymethod.reloc_external' class='method'><code id='reloc_external.v'>fn <a href='#tymethod.reloc_external' class='fnname'>reloc_external</a>(&mut self, _: <a class="enum" href="../../cranelift_codegen/binemit/enum.Reloc.html" title="enum cranelift_codegen::binemit::Reloc">Reloc</a>, _: &<a class="enum" href="../../cranelift_codegen/ir/enum.ExternalName.html" title="enum cranelift_codegen::ir::ExternalName">ExternalName</a>, _: <a class="type" href="../../cranelift_codegen/binemit/type.Addend.html" title="type cranelift_codegen::binemit::Addend">Addend</a>)</code></h3><div class='docblock'><p>Add a relocation referencing an external symbol plus the addend at the current offset.</p>
|
||
</div><h3 id='tymethod.reloc_jt' class='method'><code id='reloc_jt.v'>fn <a href='#tymethod.reloc_jt' class='fnname'>reloc_jt</a>(&mut self, _: <a class="enum" href="../../cranelift_codegen/binemit/enum.Reloc.html" title="enum cranelift_codegen::binemit::Reloc">Reloc</a>, _: <a class="struct" href="../../cranelift_codegen/ir/entities/struct.JumpTable.html" title="struct cranelift_codegen::ir::entities::JumpTable">JumpTable</a>)</code></h3><div class='docblock'><p>Add a relocation referencing a jump table.</p>
|
||
</div><h3 id='tymethod.trap' class='method'><code id='trap.v'>fn <a href='#tymethod.trap' class='fnname'>trap</a>(&mut self, _: <a class="enum" href="../../cranelift_codegen/ir/enum.TrapCode.html" title="enum cranelift_codegen::ir::TrapCode">TrapCode</a>, _: <a class="struct" href="../../cranelift_codegen/ir/struct.SourceLoc.html" title="struct cranelift_codegen::ir::SourceLoc">SourceLoc</a>)</code></h3><div class='docblock'><p>Add trap information for the current offset.</p>
|
||
</div><h3 id='tymethod.begin_jumptables' class='method'><code id='begin_jumptables.v'>fn <a href='#tymethod.begin_jumptables' class='fnname'>begin_jumptables</a>(&mut self)</code></h3><div class='docblock'><p>Machine code output is complete, jump table data may follow.</p>
|
||
</div><h3 id='tymethod.begin_rodata' class='method'><code id='begin_rodata.v'>fn <a href='#tymethod.begin_rodata' class='fnname'>begin_rodata</a>(&mut self)</code></h3><div class='docblock'><p>Jump table output is complete, raw read-only data may follow.</p>
|
||
</div><h3 id='tymethod.end_codegen' class='method'><code id='end_codegen.v'>fn <a href='#tymethod.end_codegen' class='fnname'>end_codegen</a>(&mut self)</code></h3><div class='docblock'><p>Read-only data output is complete, we're done.</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-CodeSink' class='impl'><code class='in-band'>impl<'a> CodeSink for <a class="struct" href="../../cranelift_codegen/binemit/struct.MemoryCodeSink.html" title="struct cranelift_codegen::binemit::MemoryCodeSink">MemoryCodeSink</a><'a></code><a href='#impl-CodeSink' class='anchor'></a><a class='srclink' href='../../src/cranelift_codegen/binemit/memorysink.rs.html#99-152' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.offset' class="method hidden"><code id='offset.v-1'>fn <a href='#method.offset' class='fnname'>offset</a>(&self) -> <a class="type" href="../../cranelift_codegen/binemit/type.CodeOffset.html" title="type cranelift_codegen::binemit::CodeOffset">CodeOffset</a></code><a class='srclink' href='../../src/cranelift_codegen/binemit/memorysink.rs.html#100-102' title='goto source code'>[src]</a></h4><h4 id='method.put1' class="method hidden"><code id='put1.v-1'>fn <a href='#method.put1' class='fnname'>put1</a>(&mut self, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>)</code><a class='srclink' href='../../src/cranelift_codegen/binemit/memorysink.rs.html#104-106' title='goto source code'>[src]</a></h4><h4 id='method.put2' class="method hidden"><code id='put2.v-1'>fn <a href='#method.put2' class='fnname'>put2</a>(&mut self, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>)</code><a class='srclink' href='../../src/cranelift_codegen/binemit/memorysink.rs.html#108-110' title='goto source code'>[src]</a></h4><h4 id='method.put4' class="method hidden"><code id='put4.v-1'>fn <a href='#method.put4' class='fnname'>put4</a>(&mut self, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>)</code><a class='srclink' href='../../src/cranelift_codegen/binemit/memorysink.rs.html#112-114' title='goto source code'>[src]</a></h4><h4 id='method.put8' class="method hidden"><code id='put8.v-1'>fn <a href='#method.put8' class='fnname'>put8</a>(&mut self, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>)</code><a class='srclink' href='../../src/cranelift_codegen/binemit/memorysink.rs.html#116-118' title='goto source code'>[src]</a></h4><h4 id='method.reloc_ebb' class="method hidden"><code id='reloc_ebb.v-1'>fn <a href='#method.reloc_ebb' class='fnname'>reloc_ebb</a>(&mut self, rel: <a class="enum" href="../../cranelift_codegen/binemit/enum.Reloc.html" title="enum cranelift_codegen::binemit::Reloc">Reloc</a>, ebb_offset: <a class="type" href="../../cranelift_codegen/binemit/type.CodeOffset.html" title="type cranelift_codegen::binemit::CodeOffset">CodeOffset</a>)</code><a class='srclink' href='../../src/cranelift_codegen/binemit/memorysink.rs.html#120-123' title='goto source code'>[src]</a></h4><h4 id='method.reloc_external' class="method hidden"><code id='reloc_external.v-1'>fn <a href='#method.reloc_external' class='fnname'>reloc_external</a>(&mut self, rel: <a class="enum" href="../../cranelift_codegen/binemit/enum.Reloc.html" title="enum cranelift_codegen::binemit::Reloc">Reloc</a>, name: &<a class="enum" href="../../cranelift_codegen/ir/enum.ExternalName.html" title="enum cranelift_codegen::ir::ExternalName">ExternalName</a>, addend: <a class="type" href="../../cranelift_codegen/binemit/type.Addend.html" title="type cranelift_codegen::binemit::Addend">Addend</a>)</code><a class='srclink' href='../../src/cranelift_codegen/binemit/memorysink.rs.html#125-128' title='goto source code'>[src]</a></h4><h4 id='method.reloc_jt' class="method hidden"><code id='reloc_jt.v-1'>fn <a href='#method.reloc_jt' class='fnname'>reloc_jt</a>(&mut self, rel: <a class="enum" href="../../cranelift_codegen/binemit/enum.Reloc.html" title="enum cranelift_codegen::binemit::Reloc">Reloc</a>, jt: <a class="struct" href="../../cranelift_codegen/ir/entities/struct.JumpTable.html" title="struct cranelift_codegen::ir::entities::JumpTable">JumpTable</a>)</code><a class='srclink' href='../../src/cranelift_codegen/binemit/memorysink.rs.html#130-133' title='goto source code'>[src]</a></h4><h4 id='method.trap' class="method hidden"><code id='trap.v-1'>fn <a href='#method.trap' class='fnname'>trap</a>(&mut self, code: <a class="enum" href="../../cranelift_codegen/ir/enum.TrapCode.html" title="enum cranelift_codegen::ir::TrapCode">TrapCode</a>, srcloc: <a class="struct" href="../../cranelift_codegen/ir/struct.SourceLoc.html" title="struct cranelift_codegen::ir::SourceLoc">SourceLoc</a>)</code><a class='srclink' href='../../src/cranelift_codegen/binemit/memorysink.rs.html#135-138' title='goto source code'>[src]</a></h4><h4 id='method.begin_jumptables' class="method hidden"><code id='begin_jumptables.v-1'>fn <a href='#method.begin_jumptables' class='fnname'>begin_jumptables</a>(&mut self)</code><a class='srclink' href='../../src/cranelift_codegen/binemit/memorysink.rs.html#140-142' title='goto source code'>[src]</a></h4><h4 id='method.begin_rodata' class="method hidden"><code id='begin_rodata.v-1'>fn <a href='#method.begin_rodata' class='fnname'>begin_rodata</a>(&mut self)</code><a class='srclink' href='../../src/cranelift_codegen/binemit/memorysink.rs.html#144-146' title='goto source code'>[src]</a></h4><h4 id='method.end_codegen' class="method hidden"><code id='end_codegen.v-1'>fn <a href='#method.end_codegen' class='fnname'>end_codegen</a>(&mut self)</code><a class='srclink' href='../../src/cranelift_codegen/binemit/memorysink.rs.html#148-151' 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/binemit/trait.CodeSink.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>⏎</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> |