Files
rust-gpu/api/object/read/trait.ObjectSymbolTable.html
2026-04-13 16:52:47 +00:00

19 lines
20 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="A symbol table in an `Object`."><title>ObjectSymbolTable in object::read - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="object" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (02c7f9bec 2026-04-10)" data-channel="nightly" data-search-js="search-b5634cc7.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../static.files/storage-41dd4d93.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">ObjectSymbolTable</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../object/index.html">object</a><span class="version">0.37.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Object<wbr>Symbol<wbr>Table</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Symbol" title="Symbol">Symbol</a></li><li><a href="#associatedtype.SymbolIterator" title="SymbolIterator">SymbolIterator</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.symbol_by_index" title="symbol_by_index">symbol_by_index</a></li><li><a href="#tymethod.symbols" title="symbols">symbols</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In object::<wbr>read</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">object</a>::<wbr><a href="index.html">read</a></div><h1>Trait <span class="trait">Object<wbr>Symbol<wbr>Table</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/object/read/traits.rs.html#492-510">Source</a> </span></div><pre class="rust item-decl"><code>pub trait ObjectSymbolTable&lt;'data&gt;: Sealed {
type <a href="#associatedtype.Symbol" class="associatedtype">Symbol</a>: <a class="trait" href="trait.ObjectSymbol.html" title="trait object::read::ObjectSymbol">ObjectSymbol</a>&lt;'data&gt;;
type <a href="#associatedtype.SymbolIterator" class="associatedtype">SymbolIterator</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a>&lt;Item = Self::<a class="associatedtype" href="trait.ObjectSymbolTable.html#associatedtype.Symbol" title="type object::read::ObjectSymbolTable::Symbol">Symbol</a>&gt;;
// Required methods
fn <a href="#tymethod.symbols" class="fn">symbols</a>(&amp;self) -&gt; Self::<a class="associatedtype" href="trait.ObjectSymbolTable.html#associatedtype.SymbolIterator" title="type object::read::ObjectSymbolTable::SymbolIterator">SymbolIterator</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.symbol_by_index" class="fn">symbol_by_index</a>(&amp;self, index: <a class="struct" href="struct.SymbolIndex.html" title="struct object::read::SymbolIndex">SymbolIndex</a>) -&gt; <a class="type" href="type.Result.html" title="type object::read::Result">Result</a>&lt;Self::<a class="associatedtype" href="trait.ObjectSymbolTable.html#associatedtype.Symbol" title="type object::read::ObjectSymbolTable::Symbol">Symbol</a>&gt;;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A symbol table in an <a href="trait.Object.html" title="trait object::read::Object"><code>Object</code></a>.</p>
<p>This trait is part of the unified read API.</p>
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Symbol" class="method"><a class="src rightside" href="../../src/object/read/traits.rs.html#494">Source</a><h4 class="code-header">type <a href="#associatedtype.Symbol" class="associatedtype">Symbol</a>: <a class="trait" href="trait.ObjectSymbol.html" title="trait object::read::ObjectSymbol">ObjectSymbol</a>&lt;'data&gt;</h4></section></summary><div class="docblock"><p>A symbol table entry.</p>
</div></details><details class="toggle" open><summary><section id="associatedtype.SymbolIterator" class="method"><a class="src rightside" href="../../src/object/read/traits.rs.html#497">Source</a><h4 class="code-header">type <a href="#associatedtype.SymbolIterator" class="associatedtype">SymbolIterator</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a>&lt;Item = Self::<a class="associatedtype" href="trait.ObjectSymbolTable.html#associatedtype.Symbol" title="type object::read::ObjectSymbolTable::Symbol">Symbol</a>&gt;</h4></section></summary><div class="docblock"><p>An iterator for the symbols in a symbol table.</p>
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.symbols" class="method"><a class="src rightside" href="../../src/object/read/traits.rs.html#502">Source</a><h4 class="code-header">fn <a href="#tymethod.symbols" class="fn">symbols</a>(&amp;self) -&gt; Self::<a class="associatedtype" href="trait.ObjectSymbolTable.html#associatedtype.SymbolIterator" title="type object::read::ObjectSymbolTable::SymbolIterator">SymbolIterator</a></h4></section></summary><div class="docblock"><p>Get an iterator for the symbols in the table.</p>
<p>This may skip over symbols that are malformed or unsupported.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.symbol_by_index" class="method"><a class="src rightside" href="../../src/object/read/traits.rs.html#509">Source</a><h4 class="code-header">fn <a href="#tymethod.symbol_by_index" class="fn">symbol_by_index</a>(&amp;self, index: <a class="struct" href="struct.SymbolIndex.html" title="struct object::read::SymbolIndex">SymbolIndex</a>) -&gt; <a class="type" href="type.Result.html" title="type object::read::Result">Result</a>&lt;Self::<a class="associatedtype" href="trait.ObjectSymbolTable.html#associatedtype.Symbol" title="type object::read::ObjectSymbolTable::Symbol">Symbol</a>&gt;</h4></section></summary><div class="docblock"><p>Get the symbol at the given index.</p>
<p>The meaning of the index depends on the object file.</p>
<p>Returns an error if the index is invalid.</p>
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><div class="negative-marker"></div><details class="toggle implementors-toggle"><summary><section id="impl-ObjectSymbolTable%3C'data%3E-for-WasmSymbolTable%3C'data,+'file%3E" class="impl"><a class="src rightside" href="../../src/object/read/wasm.rs.html#995-1012">Source</a><a href="#impl-ObjectSymbolTable%3C'data%3E-for-WasmSymbolTable%3C'data,+'file%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'data, 'file&gt; <a class="trait" href="trait.ObjectSymbolTable.html" title="trait object::read::ObjectSymbolTable">ObjectSymbolTable</a>&lt;'data&gt; for <a class="struct" href="wasm/struct.WasmSymbolTable.html" title="struct object::read::wasm::WasmSymbolTable">WasmSymbolTable</a>&lt;'data, 'file&gt;</h3></section></summary><div class="impl-items"><section id="associatedtype.Symbol-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/object/read/wasm.rs.html#996">Source</a><a href="#associatedtype.Symbol-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Symbol" class="associatedtype">Symbol</a> = <a class="struct" href="wasm/struct.WasmSymbol.html" title="struct object::read::wasm::WasmSymbol">WasmSymbol</a>&lt;'data, 'file&gt;</h4></section><section id="associatedtype.SymbolIterator-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/object/read/wasm.rs.html#997">Source</a><a href="#associatedtype.SymbolIterator-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.SymbolIterator" class="associatedtype">SymbolIterator</a> = <a class="struct" href="wasm/struct.WasmSymbolIterator.html" title="struct object::read::wasm::WasmSymbolIterator">WasmSymbolIterator</a>&lt;'data, 'file&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ObjectSymbolTable%3C'data%3E-for-ElfSymbolTable%3C'data,+'file,+Elf,+R%3E" class="impl"><a class="src rightside" href="../../src/object/read/elf/symbol.rs.html#243-262">Source</a><a href="#impl-ObjectSymbolTable%3C'data%3E-for-ElfSymbolTable%3C'data,+'file,+Elf,+R%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'data, 'file, Elf: <a class="trait" href="elf/trait.FileHeader.html" title="trait object::read::elf::FileHeader">FileHeader</a>, R: <a class="trait" href="trait.ReadRef.html" title="trait object::read::ReadRef">ReadRef</a>&lt;'data&gt;&gt; <a class="trait" href="trait.ObjectSymbolTable.html" title="trait object::read::ObjectSymbolTable">ObjectSymbolTable</a>&lt;'data&gt; for <a class="struct" href="elf/struct.ElfSymbolTable.html" title="struct object::read::elf::ElfSymbolTable">ElfSymbolTable</a>&lt;'data, 'file, Elf, R&gt;</h3></section></summary><div class="impl-items"><section id="associatedtype.Symbol-2" class="associatedtype trait-impl"><a class="src rightside" href="../../src/object/read/elf/symbol.rs.html#246">Source</a><a href="#associatedtype.Symbol-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Symbol" class="associatedtype">Symbol</a> = <a class="struct" href="elf/struct.ElfSymbol.html" title="struct object::read::elf::ElfSymbol">ElfSymbol</a>&lt;'data, 'file, Elf, R&gt;</h4></section><section id="associatedtype.SymbolIterator-2" class="associatedtype trait-impl"><a class="src rightside" href="../../src/object/read/elf/symbol.rs.html#247">Source</a><a href="#associatedtype.SymbolIterator-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.SymbolIterator" class="associatedtype">SymbolIterator</a> = <a class="struct" href="elf/struct.ElfSymbolIterator.html" title="struct object::read::elf::ElfSymbolIterator">ElfSymbolIterator</a>&lt;'data, 'file, Elf, R&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ObjectSymbolTable%3C'data%3E-for-MachOSymbolTable%3C'data,+'file,+Mach,+R%3E" class="impl"><a class="src rightside" href="../../src/object/read/macho/symbol.rs.html#199-215">Source</a><a href="#impl-ObjectSymbolTable%3C'data%3E-for-MachOSymbolTable%3C'data,+'file,+Mach,+R%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'data, 'file, Mach, R&gt; <a class="trait" href="trait.ObjectSymbolTable.html" title="trait object::read::ObjectSymbolTable">ObjectSymbolTable</a>&lt;'data&gt; for <a class="struct" href="macho/struct.MachOSymbolTable.html" title="struct object::read::macho::MachOSymbolTable">MachOSymbolTable</a>&lt;'data, 'file, Mach, R&gt;<div class="where">where
Mach: <a class="trait" href="macho/trait.MachHeader.html" title="trait object::read::macho::MachHeader">MachHeader</a>,
R: <a class="trait" href="trait.ReadRef.html" title="trait object::read::ReadRef">ReadRef</a>&lt;'data&gt;,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Symbol-3" class="associatedtype trait-impl"><a class="src rightside" href="../../src/object/read/macho/symbol.rs.html#204">Source</a><a href="#associatedtype.Symbol-3" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Symbol" class="associatedtype">Symbol</a> = <a class="struct" href="macho/struct.MachOSymbol.html" title="struct object::read::macho::MachOSymbol">MachOSymbol</a>&lt;'data, 'file, Mach, R&gt;</h4></section><section id="associatedtype.SymbolIterator-3" class="associatedtype trait-impl"><a class="src rightside" href="../../src/object/read/macho/symbol.rs.html#205">Source</a><a href="#associatedtype.SymbolIterator-3" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.SymbolIterator" class="associatedtype">SymbolIterator</a> = <a class="struct" href="macho/struct.MachOSymbolIterator.html" title="struct object::read::macho::MachOSymbolIterator">MachOSymbolIterator</a>&lt;'data, 'file, Mach, R&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ObjectSymbolTable%3C'data%3E-for-SymbolTable%3C'data,+'file,+R%3E" class="impl"><a class="src rightside" href="../../src/object/read/any.rs.html#1059-1081">Source</a><a href="#impl-ObjectSymbolTable%3C'data%3E-for-SymbolTable%3C'data,+'file,+R%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'data, 'file, R: <a class="trait" href="trait.ReadRef.html" title="trait object::read::ReadRef">ReadRef</a>&lt;'data&gt;&gt; <a class="trait" href="trait.ObjectSymbolTable.html" title="trait object::read::ObjectSymbolTable">ObjectSymbolTable</a>&lt;'data&gt; for <a class="struct" href="struct.SymbolTable.html" title="struct object::read::SymbolTable">SymbolTable</a>&lt;'data, 'file, R&gt;</h3></section></summary><div class="impl-items"><section id="associatedtype.Symbol-4" class="associatedtype trait-impl"><a class="src rightside" href="../../src/object/read/any.rs.html#1060">Source</a><a href="#associatedtype.Symbol-4" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Symbol" class="associatedtype">Symbol</a> = <a class="struct" href="struct.Symbol.html" title="struct object::read::Symbol">Symbol</a>&lt;'data, 'file, R&gt;</h4></section><section id="associatedtype.SymbolIterator-4" class="associatedtype trait-impl"><a class="src rightside" href="../../src/object/read/any.rs.html#1061">Source</a><a href="#associatedtype.SymbolIterator-4" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.SymbolIterator" class="associatedtype">SymbolIterator</a> = <a class="struct" href="struct.SymbolIterator.html" title="struct object::read::SymbolIterator">SymbolIterator</a>&lt;'data, 'file, R&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ObjectSymbolTable%3C'data%3E-for-CoffSymbolTable%3C'data,+'file,+R,+Coff%3E" class="impl"><a class="src rightside" href="../../src/object/read/coff/symbol.rs.html#223-241">Source</a><a href="#impl-ObjectSymbolTable%3C'data%3E-for-CoffSymbolTable%3C'data,+'file,+R,+Coff%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'data, 'file, R: <a class="trait" href="trait.ReadRef.html" title="trait object::read::ReadRef">ReadRef</a>&lt;'data&gt;, Coff: <a class="trait" href="coff/trait.CoffHeader.html" title="trait object::read::coff::CoffHeader">CoffHeader</a>&gt; <a class="trait" href="trait.ObjectSymbolTable.html" title="trait object::read::ObjectSymbolTable">ObjectSymbolTable</a>&lt;'data&gt; for <a class="struct" href="coff/struct.CoffSymbolTable.html" title="struct object::read::coff::CoffSymbolTable">CoffSymbolTable</a>&lt;'data, 'file, R, Coff&gt;</h3></section></summary><div class="impl-items"><section id="associatedtype.Symbol-5" class="associatedtype trait-impl"><a class="src rightside" href="../../src/object/read/coff/symbol.rs.html#226">Source</a><a href="#associatedtype.Symbol-5" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Symbol" class="associatedtype">Symbol</a> = <a class="struct" href="coff/struct.CoffSymbol.html" title="struct object::read::coff::CoffSymbol">CoffSymbol</a>&lt;'data, 'file, R, Coff&gt;</h4></section><section id="associatedtype.SymbolIterator-5" class="associatedtype trait-impl"><a class="src rightside" href="../../src/object/read/coff/symbol.rs.html#227">Source</a><a href="#associatedtype.SymbolIterator-5" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.SymbolIterator" class="associatedtype">SymbolIterator</a> = <a class="struct" href="coff/struct.CoffSymbolIterator.html" title="struct object::read::coff::CoffSymbolIterator">CoffSymbolIterator</a>&lt;'data, 'file, R, Coff&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ObjectSymbolTable%3C'data%3E-for-XcoffSymbolTable%3C'data,+'file,+Xcoff,+R%3E" class="impl"><a class="src rightside" href="../../src/object/read/xcoff/symbol.rs.html#231-253">Source</a><a href="#impl-ObjectSymbolTable%3C'data%3E-for-XcoffSymbolTable%3C'data,+'file,+Xcoff,+R%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'data, 'file, Xcoff: <a class="trait" href="xcoff/trait.FileHeader.html" title="trait object::read::xcoff::FileHeader">FileHeader</a>, R: <a class="trait" href="trait.ReadRef.html" title="trait object::read::ReadRef">ReadRef</a>&lt;'data&gt;&gt; <a class="trait" href="trait.ObjectSymbolTable.html" title="trait object::read::ObjectSymbolTable">ObjectSymbolTable</a>&lt;'data&gt; for <a class="struct" href="xcoff/struct.XcoffSymbolTable.html" title="struct object::read::xcoff::XcoffSymbolTable">XcoffSymbolTable</a>&lt;'data, 'file, Xcoff, R&gt;</h3></section></summary><div class="impl-items"><section id="associatedtype.Symbol-6" class="associatedtype trait-impl"><a class="src rightside" href="../../src/object/read/xcoff/symbol.rs.html#234">Source</a><a href="#associatedtype.Symbol-6" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Symbol" class="associatedtype">Symbol</a> = <a class="struct" href="xcoff/struct.XcoffSymbol.html" title="struct object::read::xcoff::XcoffSymbol">XcoffSymbol</a>&lt;'data, 'file, Xcoff, R&gt;</h4></section><section id="associatedtype.SymbolIterator-6" class="associatedtype trait-impl"><a class="src rightside" href="../../src/object/read/xcoff/symbol.rs.html#235">Source</a><a href="#associatedtype.SymbolIterator-6" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.SymbolIterator" class="associatedtype">SymbolIterator</a> = <a class="struct" href="xcoff/struct.XcoffSymbolIterator.html" title="struct object::read::xcoff::XcoffSymbolIterator">XcoffSymbolIterator</a>&lt;'data, 'file, Xcoff, R&gt;</h4></section></div></details></div><script src="../../trait.impl/object/read/traits/trait.ObjectSymbolTable.js" async></script></section></div></main></body></html>