wasmer/rustdoc/goblin/elf/sym/index.html
2019-09-06 15:57:44 -07:00

54 lines
14 KiB
HTML
Raw Permalink 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 `sym` mod in crate `goblin`."><meta name="keywords" content="rust, rustlang, rust-lang, sym"><title>goblin::elf::sym - 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">&#9776;</div><a href='../../../goblin/index.html'><div class='logo-container'><img src='../../../rust-logo.png' alt='logo'></div></a><p class='location'>Module sym</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="#constants">Constants</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../../index.html'>goblin</a>::<wbr><a href='../index.html'>elf</a></p><script>window.sidebarCurrent = {name: 'sym', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../../src/goblin/elf/sym.rs.html#1-593' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../../index.html'>goblin</a>::<wbr><a href='../index.html'>elf</a>::<wbr><a class="mod" href=''>sym</a></span></h1><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table><tr class='module-item'><td><a class="mod" href="sym32/index.html" title='goblin::elf::sym::sym32 mod'>sym32</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="sym64/index.html" title='goblin::elf::sym::sym64 mod'>sym64</a></td><td class='docblock-short'></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.Sym.html" title='goblin::elf::sym::Sym struct'>Sym</a></td><td class='docblock-short'><p>A unified Sym definition - convertable to and from 32-bit and 64-bit variants</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.SymIterator.html" title='goblin::elf::sym::SymIterator struct'>SymIterator</a></td><td class='docblock-short'><p>An iterator over symbols in an ELF symbol table</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Symtab.html" title='goblin::elf::sym::Symtab struct'>Symtab</a></td><td class='docblock-short'><p>An ELF symbol table, allowing lazy iteration over symbols</p>
</td></tr></table><h2 id='constants' class='section-header'><a href="#constants">Constants</a></h2>
<table><tr class='module-item'><td><a class="constant" href="constant.STB_GLOBAL.html" title='goblin::elf::sym::STB_GLOBAL constant'>STB_GLOBAL</a></td><td class='docblock-short'><p>Global symbol.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STB_GNU_UNIQUE.html" title='goblin::elf::sym::STB_GNU_UNIQUE constant'>STB_GNU_UNIQUE</a></td><td class='docblock-short'><p>Unique symbol..</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STB_HIOS.html" title='goblin::elf::sym::STB_HIOS constant'>STB_HIOS</a></td><td class='docblock-short'><p>End of OS-specific.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STB_HIPROC.html" title='goblin::elf::sym::STB_HIPROC constant'>STB_HIPROC</a></td><td class='docblock-short'><p>End of processor-specific.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STB_LOCAL.html" title='goblin::elf::sym::STB_LOCAL constant'>STB_LOCAL</a></td><td class='docblock-short'><p>=== Sym bindings ===
Local symbol.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STB_LOOS.html" title='goblin::elf::sym::STB_LOOS constant'>STB_LOOS</a></td><td class='docblock-short'><p>Start of OS-specific.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STB_LOPROC.html" title='goblin::elf::sym::STB_LOPROC constant'>STB_LOPROC</a></td><td class='docblock-short'><p>Start of processor-specific.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STB_NUM.html" title='goblin::elf::sym::STB_NUM constant'>STB_NUM</a></td><td class='docblock-short'><p>Number of defined types..</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STB_WEAK.html" title='goblin::elf::sym::STB_WEAK constant'>STB_WEAK</a></td><td class='docblock-short'><p>Weak symbol.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STT_COMMON.html" title='goblin::elf::sym::STT_COMMON constant'>STT_COMMON</a></td><td class='docblock-short'><p>Symbol is a common data object.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STT_FILE.html" title='goblin::elf::sym::STT_FILE constant'>STT_FILE</a></td><td class='docblock-short'><p>Symbol's name is file name.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STT_FUNC.html" title='goblin::elf::sym::STT_FUNC constant'>STT_FUNC</a></td><td class='docblock-short'><p>Symbol is a code object.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STT_GNU_IFUNC.html" title='goblin::elf::sym::STT_GNU_IFUNC constant'>STT_GNU_IFUNC</a></td><td class='docblock-short'><p>Symbol is indirect code object.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STT_HIOS.html" title='goblin::elf::sym::STT_HIOS constant'>STT_HIOS</a></td><td class='docblock-short'><p>End of OS-specific.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STT_HIPROC.html" title='goblin::elf::sym::STT_HIPROC constant'>STT_HIPROC</a></td><td class='docblock-short'><p>End of processor-specific.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STT_LOOS.html" title='goblin::elf::sym::STT_LOOS constant'>STT_LOOS</a></td><td class='docblock-short'><p>Start of OS-specific.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STT_LOPROC.html" title='goblin::elf::sym::STT_LOPROC constant'>STT_LOPROC</a></td><td class='docblock-short'><p>Start of processor-specific.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STT_NOTYPE.html" title='goblin::elf::sym::STT_NOTYPE constant'>STT_NOTYPE</a></td><td class='docblock-short'><p>=== Sym types ===
Symbol type is unspecified.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STT_NUM.html" title='goblin::elf::sym::STT_NUM constant'>STT_NUM</a></td><td class='docblock-short'><p>Number of defined types.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STT_OBJECT.html" title='goblin::elf::sym::STT_OBJECT constant'>STT_OBJECT</a></td><td class='docblock-short'><p>Symbol is a data object.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STT_SECTION.html" title='goblin::elf::sym::STT_SECTION constant'>STT_SECTION</a></td><td class='docblock-short'><p>Symbol associated with a section.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STT_TLS.html" title='goblin::elf::sym::STT_TLS constant'>STT_TLS</a></td><td class='docblock-short'><p>Symbol is thread-local data object.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STV_DEFAULT.html" title='goblin::elf::sym::STV_DEFAULT constant'>STV_DEFAULT</a></td><td class='docblock-short'><p>=== Sym visibility ===
Default: Visibility is specified by the symbol's binding type</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STV_ELIMINATE.html" title='goblin::elf::sym::STV_ELIMINATE constant'>STV_ELIMINATE</a></td><td class='docblock-short'><p>Eliminate: extends the hidden attribute. Not written in any symbol table of a dynamic
executable or shared object.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STV_EXPORTED.html" title='goblin::elf::sym::STV_EXPORTED constant'>STV_EXPORTED</a></td><td class='docblock-short'><p>Exported: ensures a symbol remains global, cannot be demoted or eliminated by any other symbol
visibility technique.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STV_HIDDEN.html" title='goblin::elf::sym::STV_HIDDEN constant'>STV_HIDDEN</a></td><td class='docblock-short'><p>Hidden: Not visible to other components, necessarily protected. Binding scope becomes local
when the object is included in an executable or shared object.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STV_INTERNAL.html" title='goblin::elf::sym::STV_INTERNAL constant'>STV_INTERNAL</a></td><td class='docblock-short'><p>Internal: use of this attribute is currently reserved.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STV_PROTECTED.html" title='goblin::elf::sym::STV_PROTECTED constant'>STV_PROTECTED</a></td><td class='docblock-short'><p>Protected: Symbol defined in current component is visible in other components, but cannot be preempted.
Any reference from within the defining component must be resolved to the definition in that
component.</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STV_SINGLETON.html" title='goblin::elf::sym::STV_SINGLETON constant'>STV_SINGLETON</a></td><td class='docblock-short'><p>Singleton: ensures a symbol remains global, and that a single instance of the definition is
bound to by all references within a process. Cannot be demoted or eliminated.</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.bind_to_str.html" title='goblin::elf::sym::bind_to_str fn'>bind_to_str</a></td><td class='docblock-short'><p>Get the string for some bind.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.get_type.html" title='goblin::elf::sym::get_type fn'>get_type</a></td><td class='docblock-short'><p>Convenience function to get the &amp;'static str type from the symbols <code>st_info</code>.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.is_import.html" title='goblin::elf::sym::is_import fn'>is_import</a></td><td class='docblock-short'><p>Is this information defining an import?</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.st_bind.html" title='goblin::elf::sym::st_bind fn'>st_bind</a></td><td class='docblock-short'><p>Get the ST bind.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.st_type.html" title='goblin::elf::sym::st_type fn'>st_type</a></td><td class='docblock-short'><p>Get the ST type.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.st_visibility.html" title='goblin::elf::sym::st_visibility fn'>st_visibility</a></td><td class='docblock-short'><p>Get the ST visibility.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.type_to_str.html" title='goblin::elf::sym::type_to_str fn'>type_to_str</a></td><td class='docblock-short'><p>Get the string for some type.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.visibility_to_str.html" title='goblin::elf::sym::visibility_to_str fn'>visibility_to_str</a></td><td class='docblock-short'><p>Get the string for some visibility</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>&#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 = "goblin";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>